Trendsic Platform Service

<back to all web services

ProjectRequest

Requires Authentication
The following routes are available for this service:
GET,POST,PUT,DELETE,OPTIONS/v1/Project/{ProjectID}
GET,POST,PUT,DELETE,OPTIONS/v1/Project
GET,OPTIONS/v1/Project/GetSingle/{ProjectUID}

export class Project
{
    public ProjectID: number;
    public ProjectUID: string;
    public ProjectName: string;
    public ImageURL: string;
    public ImageKey: string;
    public ClientName: string;
    public ClientPhone: string;
    public ClientEmail: string;
    public ProjectManagerID: number;
    public ProjectManagerName: string;
    public StartDate?: string;
    public EndDate?: string;
    public ActualStartDate?: string;
    public ActualEndDate?: string;
    public JobCount: number;
    public CrewMemberCount: number;
    public EquipmentCount: number;
    public MaterialCount: number;
    public ProjectStatusID: number;
    public ProjectStatusDescription: string;
    public Budget: number;
    public CostToDate: number;
    public ProjectLocation: string;
    public ProjectType: string;
    public ProjectSponsor: string;
    public CreatedBy: string;
    public CreatedAt?: string;
    public UpdatedAt?: string;
    public ProjectDescription: string;
    public Scope: string;
    public StatusId: number;

    public constructor(init?: Partial<Project>) { (Object as any).assign(this, init); }
}

export class ProjectResponse
{
    public ResponseStatus: ResponseStatus;
    public Project: Project[] = [];

    public constructor(init?: Partial<ProjectResponse>) { (Object as any).assign(this, init); }
}

export class ProjectRequest
{
    public ProjectUID: string;
    public ProjectID: number;
    public Project: Project[] = [];

    public constructor(init?: Partial<ProjectRequest>) { (Object as any).assign(this, init); }
}

TypeScript 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/{ProjectID} 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,
			ProjectManagerID: 0,
			ProjectManagerName: String,
			StartDate: 0001-01-01,
			EndDate: 0001-01-01,
			ActualStartDate: 0001-01-01,
			ActualEndDate: 0001-01-01,
			JobCount: 0,
			CrewMemberCount: 0,
			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
		}
	]
}
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,
			ProjectManagerID: 0,
			ProjectManagerName: String,
			StartDate: 0001-01-01,
			EndDate: 0001-01-01,
			ActualStartDate: 0001-01-01,
			ActualEndDate: 0001-01-01,
			JobCount: 0,
			CrewMemberCount: 0,
			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
		}
	]
}