Trendsic Platform Service

<back to all web services

DispatchHoldsRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/dispatch/holds
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class DispatchHoldsRequest
{
    open var Days: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 DispatchHoldsRequest DTOs

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

HTTP + CSV

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

GET /v1/dispatch/holds HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}