Trendsic Platform Service

<back to all web services

RecordSeriesListRequest

"use strict";
export class RecordSeriesStats {
    /** @param {{Total?:number,Running?:number,Eligible?:number,Held?:number,Unstarted?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Total;
    /** @type {number} */
    Running;
    /** @type {number} */
    Eligible;
    /** @type {number} */
    Held;
    /** @type {number} */
    Unstarted;
}
export class ScheduleLogDto {
    /** @param {{LogId?:number,SeriesId?:number,Verb?:string,Actor?:string,What?:string,WhenLabel?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    LogId;
    /** @type {?number} */
    SeriesId;
    /** @type {string} */
    Verb;
    /** @type {string} */
    Actor;
    /** @type {string} */
    What;
    /** @type {string} */
    WhenLabel;
}
export class RecordSeriesDto {
    /** @param {{SeriesId?:number,SourceKey?:string,Code?:string,Name?:string,Years?:number,Permanent?:boolean,RetClass?:string,TriggerEvent?:string,Method?:string,ImageAndDestroy?:boolean,Citation?:string,FieldsJson?:string,Retired?:boolean,Stats?:RecordSeriesStats,History?:ScheduleLogDto[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    SeriesId;
    /** @type {string} */
    SourceKey;
    /** @type {string} */
    Code;
    /** @type {string} */
    Name;
    /** @type {number} */
    Years;
    /** @type {boolean} */
    Permanent;
    /** @type {string} */
    RetClass;
    /** @type {string} */
    TriggerEvent;
    /** @type {string} */
    Method;
    /** @type {boolean} */
    ImageAndDestroy;
    /** @type {string} */
    Citation;
    /** @type {string} */
    FieldsJson;
    /** @type {boolean} */
    Retired;
    /** @type {RecordSeriesStats} */
    Stats;
    /** @type {ScheduleLogDto[]} */
    History = [];
}
export class RecordSeriesListResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Series?:RecordSeriesDto[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {RecordSeriesDto[]} */
    Series = [];
}
export class RecordSeriesListRequest {
    /** @param {{IncludeStats?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {boolean} */
    IncludeStats;
}

JavaScript RecordSeriesListRequest DTOs

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

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

<RecordSeriesListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <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>
  <Series>
    <RecordSeriesDto>
      <Citation>String</Citation>
      <Code>String</Code>
      <FieldsJson>String</FieldsJson>
      <History>
        <ScheduleLogDto>
          <Actor>String</Actor>
          <LogId>0</LogId>
          <SeriesId>0</SeriesId>
          <Verb>String</Verb>
          <What>String</What>
          <WhenLabel>String</WhenLabel>
        </ScheduleLogDto>
      </History>
      <ImageAndDestroy>false</ImageAndDestroy>
      <Method>String</Method>
      <Name>String</Name>
      <Permanent>false</Permanent>
      <RetClass>String</RetClass>
      <Retired>false</Retired>
      <SeriesId>0</SeriesId>
      <SourceKey>String</SourceKey>
      <Stats>
        <Eligible>0</Eligible>
        <Held>0</Held>
        <Running>0</Running>
        <Total>0</Total>
        <Unstarted>0</Unstarted>
      </Stats>
      <TriggerEvent>String</TriggerEvent>
      <Years>0</Years>
    </RecordSeriesDto>
  </Series>
</RecordSeriesListResponse>