Trendsic Platform Service

<back to all web services

DispatchHoldSuggestionDismissRequest

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/suggestion/dismiss
DispatchHoldSuggestionDismissRequest Parameters:
NameParameterData TypeRequiredDescription
ForDatebodystringNo
KindbodystringNo
DispatchHoldsResponse Parameters:
NameParameterData TypeRequiredDescription
HoldsformList<DispatchHoldView>No
WindowsformList<DispatchOfflineWindowView>No
ScopesformList<DispatchHoldScopeView>No
SuggestionformDispatchHoldSuggestionViewNo
ResponseStatusformResponseStatusNo
DispatchHoldView Parameters:
NameParameterData TypeRequiredDescription
HoldIdformintNo
CodeformstringNo
ScopeKindformstringNo
ScopeKeyformstringNo
ScopeLabelformstringNo
ReasonformstringNo
NoteformstringNo
StartUtcformDateTimeNo
EndUtcformDateTimeNo
SourceformstringNo
IncidentRefformstringNo
LiftedUtcformDateTime?No
LiftedByformstringNo
CreatedUtcformDateTime?No
CreatedByformstringNo
StatusformstringNo
DispatchOfflineWindowView Parameters:
NameParameterData TypeRequiredDescription
OfflineWindowIdformintNo
FromHourformstringNo
ToHourformstringNo
DispatchHoldScopeView Parameters:
NameParameterData TypeRequiredDescription
KindformstringNo
KeyformstringNo
LabelformstringNo
DispatchHoldSuggestionView Parameters:
NameParameterData TypeRequiredDescription
ForDateformstringNo
KindformstringNo
SeverityformintNo
HeadlineformstringNo
DayLabelformstringNo
ScopeKindformstringNo
ScopeLabelformstringNo
ReasonformstringNo
StartUtcformDateTimeNo
EndUtcformDateTimeNo
WindowLocalformstringNo
TextformstringNo

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

HTTP + OTHER

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

POST /v1/dispatch/holds/suggestion/dismiss HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"ForDate":"String","Kind":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}