Trendsic Platform Service

<back to all web services

QueueSweepRequest

The following routes are available for this service:
POST/v1/queue/sweep
"use strict";
export class LocationSweepResult {
    /** @param {{LocationId?:string,LocationName?:string,NoShow?:number,Unfulfilled?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    LocationId;
    /** @type {string} */
    LocationName;
    /** @type {number} */
    NoShow;
    /** @type {number} */
    Unfulfilled;
}
export class QueueSweepResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Locations?:LocationSweepResult[],TotalNoShow?:number,TotalUnfulfilled?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {LocationSweepResult[]} */
    Locations = [];
    /** @type {number} */
    TotalNoShow;
    /** @type {number} */
    TotalUnfulfilled;
}
export class QueueSweepRequest {
    constructor(init) { Object.assign(this, init) }
}

JavaScript QueueSweepRequest 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/queue/sweep HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

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

<QueueSweepResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Locations>
    <QueueSweepService.LocationSweepResult>
      <LocationId>00000000-0000-0000-0000-000000000000</LocationId>
      <LocationName>String</LocationName>
      <NoShow>0</NoShow>
      <Unfulfilled>0</Unfulfilled>
    </QueueSweepService.LocationSweepResult>
  </Locations>
  <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>
  <TotalNoShow>0</TotalNoShow>
  <TotalUnfulfilled>0</TotalUnfulfilled>
</QueueSweepResponse>