Trendsic Platform Service

<back to all web services

MaterialProjectRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/Material/{MaterialID}/Projects
MaterialProjectRequest Parameters:
NameParameterData TypeRequiredDescription
MaterialIDpathintNo
MaterialProjectResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ProjectsformList<Project>No
Project Parameters:
NameParameterData TypeRequiredDescription
ProjectIDformintNo
ProjectUIDformGuidNo
ProjectNameformstringNo
ImageURLformstringNo
ImageKeyformstringNo
ClientNameformstringNo
ClientPhoneformstringNo
ClientEmailformstringNo
ProjectManagerIDformintNo
ProjectManagerNameformstringNo
StartDateformDateTime?No
EndDateformDateTime?No
ActualStartDateformDateTime?No
ActualEndDateformDateTime?No
JobCountformintNo
CrewMemberCountformintNo
EquipmentCountformintNo
MaterialCountformintNo
ProjectStatusIDformshortNo
ProjectStatusDescriptionformstringNo
BudgetformdecimalNo
CostToDateformdecimalNo
ProjectLocationformstringNo
ProjectTypeformstringNo
ProjectSponsorformstringNo
CreatedByformstringNo
CreatedAtformDateTime?No
UpdatedAtformDateTime?No
ProjectDescriptionformstringNo
ScopeformstringNo
StatusIdformintNo

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.

GET /v1/Material/{MaterialID}/Projects HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
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
		}
	},
	Projects: 
	[
		{
			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
		}
	]
}