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

{}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Locations":[{"LocationId":"00000000000000000000000000000000","LocationName":"String","NoShow":0,"Unfulfilled":0}],"TotalNoShow":0,"TotalUnfulfilled":0}