Trendsic Platform Service

<back to all web services

EquipmentRequest

Requires Authentication
The following routes are available for this service:
GET,POST,PUT,DELETE,OPTIONS/v1/Equipment/{EquipmentID}
GET,POST,PUT,DELETE,OPTIONS/v1/Equipment
EquipmentRequest Parameters:
NameParameterData TypeRequiredDescription
EquipmentIDpathintNo
EquipmentbodyList<Equipment>No
Equipment Parameters:
NameParameterData TypeRequiredDescription
EquipmentIDformintNo
EquipmentNameformstringNo
EquipmentTypeIDformshortNo
ManufacturerformstringNo
EquipmentTypeformstringNo
SerialNumberformstringNo
BarCodeformstringNo
EquipmentLocationformstringNo
ImageURLformstringNo
ProductDetailsURLformstringNo
RecordCreatedDateformDateTimeNo
CreatedByUIDformGuidNo
ActiveformboolNo
NotesformstringNo
RateformdecimalNo
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
EquipmentResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
EquipmentformList<Equipment>No

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/Equipment/{EquipmentID} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	EquipmentID: 0,
	Equipment: 
	[
		{
			EquipmentID: 0,
			EquipmentName: String,
			EquipmentTypeID: 0,
			Manufacturer: String,
			EquipmentType: String,
			SerialNumber: String,
			BarCode: String,
			EquipmentLocation: String,
			ImageURL: String,
			ProductDetailsURL: String,
			RecordCreatedDate: 0001-01-01,
			CreatedByUID: 00000000000000000000000000000000,
			Active: False,
			Notes: String,
			Rate: 0,
			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
				}
			]
		}
	]
}
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
		}
	},
	Equipment: 
	[
		{
			EquipmentID: 0,
			EquipmentName: String,
			EquipmentTypeID: 0,
			Manufacturer: String,
			EquipmentType: String,
			SerialNumber: String,
			BarCode: String,
			EquipmentLocation: String,
			ImageURL: String,
			ProductDetailsURL: String,
			RecordCreatedDate: 0001-01-01,
			CreatedByUID: 00000000000000000000000000000000,
			Active: False,
			Notes: String,
			Rate: 0,
			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
				}
			]
		}
	]
}