Trendsic Platform Service

<back to all web services

DispositionBatchesRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/records/disposition/batches
"use strict";
export class DispositionBatchDto {
    /** @param {{BatchId?:number,BatchKey?:string,Title?:string,Status?:string,MethodSummary?:string,CreatedByLbl?:string,CreatedLabel?:string,ItemsJson?:string,ChainJson?:string,ReturnReason?:string,CertJson?:string,LogJson?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    BatchId;
    /** @type {string} */
    BatchKey;
    /** @type {string} */
    Title;
    /** @type {string} */
    Status;
    /** @type {string} */
    MethodSummary;
    /** @type {string} */
    CreatedByLbl;
    /** @type {string} */
    CreatedLabel;
    /** @type {string} */
    ItemsJson;
    /** @type {string} */
    ChainJson;
    /** @type {string} */
    ReturnReason;
    /** @type {string} */
    CertJson;
    /** @type {string} */
    LogJson;
}
export class DispositionBatchesResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Batches?:DispositionBatchDto[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {DispositionBatchDto[]} */
    Batches = [];
}
export class DispositionBatchesRequest {
    constructor(init) { Object.assign(this, init) }
}

JavaScript DispositionBatchesRequest 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/batches HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

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

<DispositionBatchesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Batches>
    <DispositionBatchDto>
      <BatchId>0</BatchId>
      <BatchKey>String</BatchKey>
      <CertJson>String</CertJson>
      <ChainJson>String</ChainJson>
      <CreatedByLbl>String</CreatedByLbl>
      <CreatedLabel>String</CreatedLabel>
      <ItemsJson>String</ItemsJson>
      <LogJson>String</LogJson>
      <MethodSummary>String</MethodSummary>
      <ReturnReason>String</ReturnReason>
      <Status>String</Status>
      <Title>String</Title>
    </DispositionBatchDto>
  </Batches>
  <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>
</DispositionBatchesResponse>