Trendsic Platform Service

<back to all web services

ProjectRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/Project/GetSingle/{ProjectUID}
GET,POST,PUT,DELETE,OPTIONS/v1/Project
GET,POST,PUT,DELETE,OPTIONS/v1/Project/{ProjectID}
"use strict";
export class Location {
    /** @param {{Id?:string,ClientId?:string,Name?:string,Address1?:string,Address2?:string,City?:string,State?:string,Zip?:string,Phone?:string,Fax?:string,URL?:string,Email?:string,TimeZone?:string,Active?:boolean,EntDate?:string,ModDate?:string,LocationImage?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Id;
    /** @type {string} */
    ClientId;
    /** @type {string} */
    Name;
    /** @type {string} */
    Address1;
    /** @type {string} */
    Address2;
    /** @type {string} */
    City;
    /** @type {string} */
    State;
    /** @type {string} */
    Zip;
    /** @type {string} */
    Phone;
    /** @type {string} */
    Fax;
    /** @type {string} */
    URL;
    /** @type {string} */
    Email;
    /** @type {string} */
    TimeZone;
    /** @type {boolean} */
    Active;
    /** @type {string} */
    EntDate;
    /** @type {string} */
    ModDate;
    /** @type {string} */
    LocationImage;
}
export class Project {
    /** @param {{ProjectID?:number,ProjectUID?:string,ProjectName?:string,ImageURL?:string,ImageKey?:string,ClientName?:string,ClientPhone?:string,ClientEmail?:string,NotifyCustomerOnVisitCompletion?:boolean,ClientContactID?:number,ProjectManagerID?:number,ProjectManagerName?:string,StartDate?:string,EndDate?:string,ActualStartDate?:string,ActualEndDate?:string,JobCount?:number,CrewMemberCount?:number,CrewAvatarsJson?:string,CrewNamesSearch?:string,EquipmentCount?:number,MaterialCount?:number,ProjectStatusID?:number,ProjectStatusDescription?:string,Budget?:number,CostToDate?:number,ProjectLocation?:string,ProjectType?:string,ProjectSponsor?:string,CreatedBy?:string,CreatedAt?:string,UpdatedAt?:string,ProjectDescription?:string,Scope?:string,StatusId?:number,BranchId?:string,BranchName?:string,Location?:Location}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ProjectID;
    /** @type {string} */
    ProjectUID;
    /** @type {string} */
    ProjectName;
    /** @type {string} */
    ImageURL;
    /** @type {string} */
    ImageKey;
    /** @type {string} */
    ClientName;
    /** @type {string} */
    ClientPhone;
    /** @type {string} */
    ClientEmail;
    /** @type {boolean} */
    NotifyCustomerOnVisitCompletion;
    /** @type {?number} */
    ClientContactID;
    /** @type {number} */
    ProjectManagerID;
    /** @type {string} */
    ProjectManagerName;
    /** @type {?string} */
    StartDate;
    /** @type {?string} */
    EndDate;
    /** @type {?string} */
    ActualStartDate;
    /** @type {?string} */
    ActualEndDate;
    /** @type {number} */
    JobCount;
    /** @type {number} */
    CrewMemberCount;
    /** @type {string} */
    CrewAvatarsJson;
    /** @type {string} */
    CrewNamesSearch;
    /** @type {number} */
    EquipmentCount;
    /** @type {number} */
    MaterialCount;
    /** @type {number} */
    ProjectStatusID;
    /** @type {string} */
    ProjectStatusDescription;
    /** @type {number} */
    Budget;
    /** @type {number} */
    CostToDate;
    /** @type {string} */
    ProjectLocation;
    /** @type {string} */
    ProjectType;
    /** @type {string} */
    ProjectSponsor;
    /** @type {string} */
    CreatedBy;
    /** @type {?string} */
    CreatedAt;
    /** @type {?string} */
    UpdatedAt;
    /** @type {string} */
    ProjectDescription;
    /** @type {string} */
    Scope;
    /** @type {number} */
    StatusId;
    /** @type {string} */
    BranchId;
    /** @type {string} */
    BranchName;
    /** @type {Location} */
    Location;
}
export class ProjectResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Project?:Project[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {Project[]} */
    Project = [];
}
export class ProjectRequest {
    /** @param {{ProjectUID?:string,ProjectID?:number,Project?:Project[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ProjectUID;
    /** @type {number} */
    ProjectID;
    /** @type {Project[]} */
    Project = [];
}

JavaScript ProjectRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/Project HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ProjectUID: 00000000000000000000000000000000,
	ProjectID: 0,
	Project: 
	[
		{
			ProjectID: 0,
			ProjectUID: 00000000000000000000000000000000,
			ProjectName: String,
			ImageURL: String,
			ImageKey: String,
			ClientName: String,
			ClientPhone: String,
			ClientEmail: String,
			NotifyCustomerOnVisitCompletion: False,
			ClientContactID: 0,
			ProjectManagerID: 0,
			ProjectManagerName: String,
			StartDate: 0001-01-01,
			EndDate: 0001-01-01,
			ActualStartDate: 0001-01-01,
			ActualEndDate: 0001-01-01,
			JobCount: 0,
			CrewMemberCount: 0,
			CrewAvatarsJson: String,
			CrewNamesSearch: String,
			EquipmentCount: 0,
			MaterialCount: 0,
			ProjectStatusID: 0,
			ProjectStatusDescription: String,
			Budget: 0,
			CostToDate: 0,
			ProjectLocation: String,
			ProjectType: String,
			ProjectSponsor: String,
			CreatedBy: String,
			CreatedAt: 0001-01-01,
			UpdatedAt: 0001-01-01,
			ProjectDescription: String,
			Scope: String,
			StatusId: 0,
			BranchId: 00000000000000000000000000000000,
			BranchName: String,
			Location: 
			{
				Id: 00000000000000000000000000000000,
				ClientId: 00000000000000000000000000000000,
				Name: String,
				Address1: String,
				Address2: String,
				City: String,
				State: String,
				Zip: String,
				Phone: String,
				Fax: String,
				URL: String,
				Email: String,
				TimeZone: String,
				Active: False,
				EntDate: 0001-01-01,
				ModDate: 0001-01-01,
				LocationImage: String
			}
		}
	]
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	Project: 
	[
		{
			ProjectID: 0,
			ProjectUID: 00000000000000000000000000000000,
			ProjectName: String,
			ImageURL: String,
			ImageKey: String,
			ClientName: String,
			ClientPhone: String,
			ClientEmail: String,
			NotifyCustomerOnVisitCompletion: False,
			ClientContactID: 0,
			ProjectManagerID: 0,
			ProjectManagerName: String,
			StartDate: 0001-01-01,
			EndDate: 0001-01-01,
			ActualStartDate: 0001-01-01,
			ActualEndDate: 0001-01-01,
			JobCount: 0,
			CrewMemberCount: 0,
			CrewAvatarsJson: String,
			CrewNamesSearch: String,
			EquipmentCount: 0,
			MaterialCount: 0,
			ProjectStatusID: 0,
			ProjectStatusDescription: String,
			Budget: 0,
			CostToDate: 0,
			ProjectLocation: String,
			ProjectType: String,
			ProjectSponsor: String,
			CreatedBy: String,
			CreatedAt: 0001-01-01,
			UpdatedAt: 0001-01-01,
			ProjectDescription: String,
			Scope: String,
			StatusId: 0,
			BranchId: 00000000000000000000000000000000,
			BranchName: String,
			Location: 
			{
				Id: 00000000000000000000000000000000,
				ClientId: 00000000000000000000000000000000,
				Name: String,
				Address1: String,
				Address2: String,
				City: String,
				State: String,
				Zip: String,
				Phone: String,
				Fax: String,
				URL: String,
				Email: String,
				TimeZone: String,
				Active: False,
				EntDate: 0001-01-01,
				ModDate: 0001-01-01,
				LocationImage: String
			}
		}
	]
}