Trendsic Platform Service

<back to all web services

DispatchPatternRequest

Requires Authentication
The following routes are available for this service:
PUT,OPTIONS/v1/dispatch/settings/pattern
"use strict";
export class DispatchModuleView {
    /** @param {{Key?:string,Mode?:string,Allowed?:boolean,Enabled?:boolean,InFlight?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Key;
    /** @type {string} */
    Mode;
    /** @type {boolean} */
    Allowed;
    /** @type {boolean} */
    Enabled;
    /** @type {number} */
    InFlight;
}
export class DispatchPatternView {
    /** @param {{PatternId?:string,Name?:string,Source?:string,Facility?:string,Unit?:string,HasQuotas?:boolean,IsInverted?:boolean,LoadLimitMins?:number,TicketSource?:string,PayBasis?:string,IsActive?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    PatternId;
    /** @type {string} */
    Name;
    /** @type {string} */
    Source;
    /** @type {string} */
    Facility;
    /** @type {string} */
    Unit;
    /** @type {boolean} */
    HasQuotas;
    /** @type {boolean} */
    IsInverted;
    /** @type {number} */
    LoadLimitMins;
    /** @type {string} */
    TicketSource;
    /** @type {string} */
    PayBasis;
    /** @type {boolean} */
    IsActive;
}
export class DispatchModulesResponse {
    /** @param {{Modules?:DispatchModuleView[],Patterns?:DispatchPatternView[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {DispatchModuleView[]} */
    Modules = [];
    /** @type {DispatchPatternView[]} */
    Patterns = [];
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class DispatchPatternRequest {
    /** @param {{PatternId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    PatternId;
}

JavaScript DispatchPatternRequest 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.

PUT /v1/dispatch/settings/pattern HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

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

<DispatchModulesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Modules>
    <DispatchModuleView>
      <Allowed>false</Allowed>
      <Enabled>false</Enabled>
      <InFlight>0</InFlight>
      <Key>String</Key>
      <Mode>String</Mode>
    </DispatchModuleView>
  </Modules>
  <Patterns>
    <DispatchPatternView>
      <Facility>String</Facility>
      <HasQuotas>false</HasQuotas>
      <IsActive>false</IsActive>
      <IsInverted>false</IsInverted>
      <LoadLimitMins>0</LoadLimitMins>
      <Name>String</Name>
      <PatternId>String</PatternId>
      <PayBasis>String</PayBasis>
      <Source>String</Source>
      <TicketSource>String</TicketSource>
      <Unit>String</Unit>
    </DispatchPatternView>
  </Patterns>
  <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>
</DispatchModulesResponse>