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

namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type DispatchHoldView() = 
        member val HoldId:Int32 = new Int32() with get,set
        member val Code:String = null with get,set
        member val ScopeKind:String = null with get,set
        member val ScopeKey:String = null with get,set
        member val ScopeLabel:String = null with get,set
        member val Reason:String = null with get,set
        member val Note:String = null with get,set
        member val StartUtc:DateTime = new DateTime() with get,set
        member val EndUtc:DateTime = new DateTime() with get,set
        member val Source:String = null with get,set
        member val IncidentRef:String = null with get,set
        member val LiftedUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val LiftedBy:String = null with get,set
        member val CreatedUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val CreatedBy:String = null with get,set
        member val Status:String = null with get,set

    [<AllowNullLiteral>]
    type DispatchOfflineWindowView() = 
        member val OfflineWindowId:Int32 = new Int32() with get,set
        member val FromHour:String = null with get,set
        member val ToHour:String = null with get,set

    [<AllowNullLiteral>]
    type DispatchHoldScopeView() = 
        member val Kind:String = null with get,set
        member val Key:String = null with get,set
        member val Label:String = null with get,set

    [<AllowNullLiteral>]
    type DispatchHoldSuggestionView() = 
        member val ForDate:String = null with get,set
        member val Kind:String = null with get,set
        member val Severity:Int32 = new Int32() with get,set
        member val Headline:String = null with get,set
        member val DayLabel:String = null with get,set
        member val ScopeKind:String = null with get,set
        member val ScopeLabel:String = null with get,set
        member val Reason:String = null with get,set
        member val StartUtc:DateTime = new DateTime() with get,set
        member val EndUtc:DateTime = new DateTime() with get,set
        member val WindowLocal:String = null with get,set
        member val Text:String = null with get,set

    [<AllowNullLiteral>]
    type DispatchHoldsResponse() = 
        member val Holds:ResizeArray<DispatchHoldView> = new ResizeArray<DispatchHoldView>() with get,set
        member val Windows:ResizeArray<DispatchOfflineWindowView> = new ResizeArray<DispatchOfflineWindowView>() with get,set
        member val Scopes:ResizeArray<DispatchHoldScopeView> = new ResizeArray<DispatchHoldScopeView>() with get,set
        member val Suggestion:DispatchHoldSuggestionView = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type DispatchHoldCreateRequest() = 
        member val ScopeKind:String = null with get,set
        member val ScopeKey:String = null with get,set
        member val ScopeLabel:String = null with get,set
        member val Reason:String = null with get,set
        member val Note:String = null with get,set
        member val StartUtc:String = null with get,set
        member val EndUtc:String = null with get,set
        member val SuggestionDate:String = null with get,set
        member val SuggestionKind:String = null with get,set

F# 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"}}}