Trendsic Platform Service

<back to all web services

DispositionQueueRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/records/disposition/queue
"use strict";
export class RecordDto {
    /** @param {{RecordId?:number,RecordKey?:string,Name?:string,SeriesId?:number,SeriesKey?:string,Classification?:string,Format?:string,Phase?:string,TriggerDate?:string,Staged?:boolean,HoldId?:number,HoldKey?:string,OwnerName?:string,Branch?:string,Barcode?:string,LocJson?:string,MetaJson?:string,FilesJson?:string,VersionsJson?:string,RelatedJson?:string,DisposedJson?:string,CreatedLabel?:string,UpdatedLabel?:string,Lifecycle?:string,RetKind?:string,EligibleDate?:string,MonthsLeft?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    RecordId;
    /** @type {string} */
    RecordKey;
    /** @type {string} */
    Name;
    /** @type {?number} */
    SeriesId;
    /** @type {string} */
    SeriesKey;
    /** @type {string} */
    Classification;
    /** @type {string} */
    Format;
    /** @type {string} */
    Phase;
    /** @type {string} */
    TriggerDate;
    /** @type {boolean} */
    Staged;
    /** @type {?number} */
    HoldId;
    /** @type {string} */
    HoldKey;
    /** @type {string} */
    OwnerName;
    /** @type {string} */
    Branch;
    /** @type {string} */
    Barcode;
    /** @type {string} */
    LocJson;
    /** @type {string} */
    MetaJson;
    /** @type {string} */
    FilesJson;
    /** @type {string} */
    VersionsJson;
    /** @type {string} */
    RelatedJson;
    /** @type {string} */
    DisposedJson;
    /** @type {string} */
    CreatedLabel;
    /** @type {string} */
    UpdatedLabel;
    /** @type {string} */
    Lifecycle;
    /** @type {string} */
    RetKind;
    /** @type {string} */
    EligibleDate;
    /** @type {number} */
    MonthsLeft;
}
export class RecordsSearchResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Records?:RecordDto[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {RecordDto[]} */
    Records = [];
}
export class DispositionQueueRequest {
    constructor(init) { Object.assign(this, init) }
}

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

GET /v1/records/disposition/queue HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

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

<RecordsSearchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Records>
    <RecordDto>
      <Barcode>String</Barcode>
      <Branch>String</Branch>
      <Classification>String</Classification>
      <CreatedLabel>String</CreatedLabel>
      <DisposedJson>String</DisposedJson>
      <EligibleDate>String</EligibleDate>
      <FilesJson>String</FilesJson>
      <Format>String</Format>
      <HoldId>0</HoldId>
      <HoldKey>String</HoldKey>
      <Lifecycle>String</Lifecycle>
      <LocJson>String</LocJson>
      <MetaJson>String</MetaJson>
      <MonthsLeft>0</MonthsLeft>
      <Name>String</Name>
      <OwnerName>String</OwnerName>
      <Phase>String</Phase>
      <RecordId>0</RecordId>
      <RecordKey>String</RecordKey>
      <RelatedJson>String</RelatedJson>
      <RetKind>String</RetKind>
      <SeriesId>0</SeriesId>
      <SeriesKey>String</SeriesKey>
      <Staged>false</Staged>
      <TriggerDate>String</TriggerDate>
      <UpdatedLabel>String</UpdatedLabel>
      <VersionsJson>String</VersionsJson>
    </RecordDto>
  </Records>
  <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>
</RecordsSearchResponse>