Trendsic Platform Service

<back to all web services

AgreementNeedsSetRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/territory/agreementneeds
AgreementNeedsSetRequest Parameters:
NameParameterData TypeRequiredDescription
AgreementIDbodyintNo
EquipmentIDsbodyList<int>No
TerritoryResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
TerritoriesformList<Territory>No
PropertiesformList<TerritoryPropertyRow>No
CrewEquipmentformList<CrewEquipmentRow>No
AgreementNeedsformList<AgreementNeedRow>No
Territory Parameters:
NameParameterData TypeRequiredDescription
TerritoryIDformintNo
TerritoryUIDformstringNo
NameformstringNo
ColorformstringNo
ZipCsvformstringNo
CrewIDformint?No
CrewNameformstringNo
ActiveformboolNo
TerritoryPropertyRow Parameters:
NameParameterData TypeRequiredDescription
TerritoryIDformintNo
AgreementIDformintNo
CrewEquipmentRow Parameters:
NameParameterData TypeRequiredDescription
CrewIDformintNo
EquipmentIDformintNo
EquipmentNameformstringNo
AgreementNeedRow Parameters:
NameParameterData TypeRequiredDescription
AgreementIDformintNo
EquipmentIDformintNo
EquipmentNameformstringNo

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

HTTP + CSV

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

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

{"AgreementID":0,"EquipmentIDs":[0]}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Territories":[{"TerritoryID":0,"TerritoryUID":"String","Name":"String","Color":"String","ZipCsv":"String","CrewID":0,"CrewName":"String","Active":false}],"Properties":[{"TerritoryID":0,"AgreementID":0}],"CrewEquipment":[{"CrewID":0,"EquipmentID":0,"EquipmentName":"String"}],"AgreementNeeds":[{"AgreementID":0,"EquipmentID":0,"EquipmentName":"String"}]}