Trendsic Platform Service

<back to all web services

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
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CRM.AgencyPlatform.API.Internal;

namespace CRM.AgencyPlatform.API.Internal
{
    public partial class DispatchHoldLiftRequest
    {
        public virtual int HoldId { get; set; }
    }

    public partial class DispatchHoldScopeView
    {
        public virtual string Kind { get; set; }
        public virtual string Key { get; set; }
        public virtual string Label { get; set; }
    }

    public partial class DispatchHoldsResponse
    {
        public virtual List<DispatchHoldView> Holds { get; set; } = [];
        public virtual List<DispatchOfflineWindowView> Windows { get; set; } = [];
        public virtual List<DispatchHoldScopeView> Scopes { get; set; } = [];
        public virtual DispatchHoldSuggestionView Suggestion { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

    public partial class DispatchHoldSuggestionView
    {
        public virtual string ForDate { get; set; }
        public virtual string Kind { get; set; }
        public virtual int Severity { get; set; }
        public virtual string Headline { get; set; }
        public virtual string DayLabel { get; set; }
        public virtual string ScopeKind { get; set; }
        public virtual string ScopeLabel { get; set; }
        public virtual string Reason { get; set; }
        public virtual DateTime StartUtc { get; set; }
        public virtual DateTime EndUtc { get; set; }
        public virtual string WindowLocal { get; set; }
        public virtual string Text { get; set; }
    }

    public partial class DispatchHoldView
    {
        public virtual int HoldId { get; set; }
        public virtual string Code { get; set; }
        public virtual string ScopeKind { get; set; }
        public virtual string ScopeKey { get; set; }
        public virtual string ScopeLabel { get; set; }
        public virtual string Reason { get; set; }
        public virtual string Note { get; set; }
        public virtual DateTime StartUtc { get; set; }
        public virtual DateTime EndUtc { get; set; }
        public virtual string Source { get; set; }
        public virtual string IncidentRef { get; set; }
        public virtual DateTime? LiftedUtc { get; set; }
        public virtual string LiftedBy { get; set; }
        public virtual DateTime? CreatedUtc { get; set; }
        public virtual string CreatedBy { get; set; }
        public virtual string Status { get; set; }
    }

    public partial class DispatchOfflineWindowView
    {
        public virtual int OfflineWindowId { get; set; }
        public virtual string FromHour { get; set; }
        public virtual string ToHour { get; set; }
    }

}

C# DispatchHoldLiftRequest 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.

POST /v1/dispatch/holds/{HoldId}/lift HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"HoldId":0}
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"}}}