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

Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CRM.AgencyPlatform.API.Internal

Namespace Global

    Namespace CRM.AgencyPlatform.API.Internal

        Public Partial Class DispatchHoldCreateRequest
            Public Overridable Property ScopeKind As String
            Public Overridable Property ScopeKey As String
            Public Overridable Property ScopeLabel As String
            Public Overridable Property Reason As String
            Public Overridable Property Note As String
            Public Overridable Property StartUtc As String
            Public Overridable Property EndUtc As String
            Public Overridable Property SuggestionDate As String
            Public Overridable Property SuggestionKind As String
        End Class

        Public Partial Class DispatchHoldScopeView
            Public Overridable Property Kind As String
            Public Overridable Property Key As String
            Public Overridable Property Label As String
        End Class

        Public Partial Class DispatchHoldsResponse
            Public Overridable Property Holds As List(Of DispatchHoldView) = New List(Of DispatchHoldView)
            Public Overridable Property Windows As List(Of DispatchOfflineWindowView) = New List(Of DispatchOfflineWindowView)
            Public Overridable Property Scopes As List(Of DispatchHoldScopeView) = New List(Of DispatchHoldScopeView)
            Public Overridable Property Suggestion As DispatchHoldSuggestionView
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class

        Public Partial Class DispatchHoldSuggestionView
            Public Overridable Property ForDate As String
            Public Overridable Property Kind As String
            Public Overridable Property Severity As Integer
            Public Overridable Property Headline As String
            Public Overridable Property DayLabel As String
            Public Overridable Property ScopeKind As String
            Public Overridable Property ScopeLabel As String
            Public Overridable Property Reason As String
            Public Overridable Property StartUtc As Date
            Public Overridable Property EndUtc As Date
            Public Overridable Property WindowLocal As String
            Public Overridable Property Text As String
        End Class

        Public Partial Class DispatchHoldView
            Public Overridable Property HoldId As Integer
            Public Overridable Property Code As String
            Public Overridable Property ScopeKind As String
            Public Overridable Property ScopeKey As String
            Public Overridable Property ScopeLabel As String
            Public Overridable Property Reason As String
            Public Overridable Property Note As String
            Public Overridable Property StartUtc As Date
            Public Overridable Property EndUtc As Date
            Public Overridable Property Source As String
            Public Overridable Property IncidentRef As String
            Public Overridable Property LiftedUtc As Date?
            Public Overridable Property LiftedBy As String
            Public Overridable Property CreatedUtc As Date?
            Public Overridable Property CreatedBy As String
            Public Overridable Property Status As String
        End Class

        Public Partial Class DispatchOfflineWindowView
            Public Overridable Property OfflineWindowId As Integer
            Public Overridable Property FromHour As String
            Public Overridable Property ToHour As String
        End Class
    End Namespace
End Namespace

VB.NET DispatchHoldCreateRequest DTOs

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 HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl
Content-Type: text/jsonl
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: 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"}}}