Trendsic Platform Service

DispatchHoldLiftRequest

**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/{HoldId}/lift

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class DispatchHoldLiftRequest
{
    open var HoldId:Int? = null
}

open class DispatchHoldsResponse
{
    open var Holds:ArrayList<DispatchHoldView> = ArrayList<DispatchHoldView>()
    open var Windows:ArrayList<DispatchOfflineWindowView> = ArrayList<DispatchOfflineWindowView>()
    open var Scopes:ArrayList<DispatchHoldScopeView> = ArrayList<DispatchHoldScopeView>()
    open var Suggestion:DispatchHoldSuggestionView? = null
    open var ResponseStatus:ResponseStatus? = null
}

open class DispatchHoldView
{
    open var HoldId:Int? = null
    open var Code:String? = null
    open var ScopeKind:String? = null
    open var ScopeKey:String? = null
    open var ScopeLabel:String? = null
    open var Reason:String? = null
    open var Note:String? = null
    open var StartUtc:Date? = null
    open var EndUtc:Date? = null
    open var Source:String? = null
    open var IncidentRef:String? = null
    open var LiftedUtc:Date? = null
    open var LiftedBy:String? = null
    open var CreatedUtc:Date? = null
    open var CreatedBy:String? = null
    open var Status:String? = null
}

open class DispatchOfflineWindowView
{
    open var OfflineWindowId:Int? = null
    open var FromHour:String? = null
    open var ToHour:String? = null
}

open class DispatchHoldScopeView
{
    open var Kind:String? = null
    open var Key:String? = null
    open var Label:String? = null
}

open class DispatchHoldSuggestionView
{
    open var ForDate:String? = null
    open var Kind:String? = null
    open var Severity:Int? = null
    open var Headline:String? = null
    open var DayLabel:String? = null
    open var ScopeKind:String? = null
    open var ScopeLabel:String? = null
    open var Reason:String? = null
    open var StartUtc:Date? = null
    open var EndUtc:Date? = null
    open var WindowLocal:String? = null
    open var Text:String? = null
}

Kotlin DispatchHoldLiftRequest 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/{HoldId}/lift HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<DispatchHoldLiftRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <HoldId>0</HoldId>
</DispatchHoldLiftRequest>

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>