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

import Foundation
import ServiceStack

public class DispatchHoldCreateRequest : Codable
{
    public var scopeKind:String
    public var scopeKey:String
    public var scopeLabel:String
    public var reason:String
    public var note:String
    public var startUtc:String
    public var endUtc:String
    public var suggestionDate:String
    public var suggestionKind:String

    required public init(){}
}

public class DispatchHoldsResponse : Codable
{
    public var holds:[DispatchHoldView] = []
    public var windows:[DispatchOfflineWindowView] = []
    public var scopes:[DispatchHoldScopeView] = []
    public var suggestion:DispatchHoldSuggestionView
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class DispatchHoldView : Codable
{
    public var holdId:Int
    public var code:String
    public var scopeKind:String
    public var scopeKey:String
    public var scopeLabel:String
    public var reason:String
    public var note:String
    public var startUtc:Date
    public var endUtc:Date
    public var source:String
    public var incidentRef:String
    public var liftedUtc:Date?
    public var liftedBy:String
    public var createdUtc:Date?
    public var createdBy:String
    public var status:String

    required public init(){}
}

public class DispatchOfflineWindowView : Codable
{
    public var offlineWindowId:Int
    public var fromHour:String
    public var toHour:String

    required public init(){}
}

public class DispatchHoldScopeView : Codable
{
    public var kind:String
    public var key:String
    public var label:String

    required public init(){}
}

public class DispatchHoldSuggestionView : Codable
{
    public var forDate:String
    public var kind:String
    public var severity:Int
    public var headline:String
    public var dayLabel:String
    public var scopeKind:String
    public var scopeLabel:String
    public var reason:String
    public var startUtc:Date
    public var endUtc:Date
    public var windowLocal:String
    public var text:String

    required public init(){}
}

Swift DispatchHoldCreateRequest DTOs

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

HTTP + XML

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/xml
Content-Type: application/xml
Content-Length: length

<DispatchHoldCreateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <EndUtc>String</EndUtc>
  <Note>String</Note>
  <Reason>String</Reason>
  <ScopeKey>String</ScopeKey>
  <ScopeKind>String</ScopeKind>
  <ScopeLabel>String</ScopeLabel>
  <StartUtc>String</StartUtc>
  <SuggestionDate>String</SuggestionDate>
  <SuggestionKind>String</SuggestionKind>
</DispatchHoldCreateRequest>

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

<DispatchHoldsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Holds>
    <DispatchHoldView>
      <Code>String</Code>
      <CreatedBy>String</CreatedBy>
      <CreatedUtc>0001-01-01T00:00:00</CreatedUtc>
      <EndUtc>0001-01-01T00:00:00</EndUtc>
      <HoldId>0</HoldId>
      <IncidentRef>String</IncidentRef>
      <LiftedBy>String</LiftedBy>
      <LiftedUtc>0001-01-01T00:00:00</LiftedUtc>
      <Note>String</Note>
      <Reason>String</Reason>
      <ScopeKey>String</ScopeKey>
      <ScopeKind>String</ScopeKind>
      <ScopeLabel>String</ScopeLabel>
      <Source>String</Source>
      <StartUtc>0001-01-01T00:00:00</StartUtc>
      <Status>String</Status>
    </DispatchHoldView>
  </Holds>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Scopes>
    <DispatchHoldScopeView>
      <Key>String</Key>
      <Kind>String</Kind>
      <Label>String</Label>
    </DispatchHoldScopeView>
  </Scopes>
  <Suggestion>
    <DayLabel>String</DayLabel>
    <EndUtc>0001-01-01T00:00:00</EndUtc>
    <ForDate>String</ForDate>
    <Headline>String</Headline>
    <Kind>String</Kind>
    <Reason>String</Reason>
    <ScopeKind>String</ScopeKind>
    <ScopeLabel>String</ScopeLabel>
    <Severity>0</Severity>
    <StartUtc>0001-01-01T00:00:00</StartUtc>
    <Text>String</Text>
    <WindowLocal>String</WindowLocal>
  </Suggestion>
  <Windows>
    <DispatchOfflineWindowView>
      <FromHour>String</FromHour>
      <OfflineWindowId>0</OfflineWindowId>
      <ToHour>String</ToHour>
    </DispatchOfflineWindowView>
  </Windows>
</DispatchHoldsResponse>