Trendsic Platform Service

DispatchHoldCreateRequest

**Requires Authentication**
Requires any of the permissions:	DISPATCH:HAUL:MANAGE, DISPATCH:JOB:MANAGE, DISPATCH:ONDEMAND:MANAGE

The following routes are available for this service:
POST,OPTIONS	/v1/dispatch/holds

**DispatchHoldCreateRequest** Parameters:
Name	Parameter	Data Type	Required
ScopeKind	body	string	No
ScopeKey	body	string	No
ScopeLabel	body	string	No
Reason	body	string	No
Note	body	string	No
StartUtc	body	string	No
EndUtc	body	string	No
SuggestionDate	body	string	No
SuggestionKind	body	string	No

**DispatchHoldsResponse** Parameters:
Name	Parameter	Data Type	Required
Holds	form	List<DispatchHoldView>	No
Windows	form	List<DispatchOfflineWindowView>	No
Scopes	form	List<DispatchHoldScopeView>	No
Suggestion	form	DispatchHoldSuggestionView	No
ResponseStatus	form	ResponseStatus	No

**DispatchHoldView** Parameters:
Name	Parameter	Data Type	Required
HoldId	form	int	No
Code	form	string	No
ScopeKind	form	string	No
ScopeKey	form	string	No
ScopeLabel	form	string	No
Reason	form	string	No
Note	form	string	No
StartUtc	form	DateTime	No
EndUtc	form	DateTime	No
Source	form	string	No
IncidentRef	form	string	No
LiftedUtc	form	DateTime?	No
LiftedBy	form	string	No
CreatedUtc	form	DateTime?	No
CreatedBy	form	string	No
Status	form	string	No

**DispatchOfflineWindowView** Parameters:
Name	Parameter	Data Type	Required
OfflineWindowId	form	int	No
FromHour	form	string	No
ToHour	form	string	No

**DispatchHoldScopeView** Parameters:
Name	Parameter	Data Type	Required
Kind	form	string	No
Key	form	string	No
Label	form	string	No

**DispatchHoldSuggestionView** Parameters:
Name	Parameter	Data Type	Required
ForDate	form	string	No
Kind	form	string	No
Severity	form	int	No
Headline	form	string	No
DayLabel	form	string	No
ScopeKind	form	string	No
ScopeLabel	form	string	No
Reason	form	string	No
StartUtc	form	DateTime	No
EndUtc	form	DateTime	No
WindowLocal	form	string	No
Text	form	string	No

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /v1/dispatch/holds HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"ScopeKind":"String","ScopeKey":"String","ScopeLabel":"String","Reason":"String","Note":"String","StartUtc":"String","EndUtc":"String","SuggestionDate":"String","SuggestionKind":"String"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Holds":[{"HoldId":0,"Code":"String","ScopeKind":"String","ScopeKey":"String","ScopeLabel":"String","Reason":"String","Note":"String","StartUtc":"0001-01-01T00:00:00.0000000","EndUtc":"0001-01-01T00:00:00.0000000","Source":"String","IncidentRef":"String","LiftedUtc":"0001-01-01T00:00:00.0000000","LiftedBy":"String","CreatedUtc":"0001-01-01T00:00:00.0000000","CreatedBy":"String","Status":"String"}],"Windows":[{"OfflineWindowId":0,"FromHour":"String","ToHour":"String"}],"Scopes":[{"Kind":"String","Key":"String","Label":"String"}],"Suggestion":{"ForDate":"String","Kind":"String","Severity":0,"Headline":"String","DayLabel":"String","ScopeKind":"String","ScopeLabel":"String","Reason":"String","StartUtc":"0001-01-01T00:00:00.0000000","EndUtc":"0001-01-01T00:00:00.0000000","WindowLocal":"String","Text":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}