Trendsic Platform Service

<back to all web services

RecordSeriesSaveRequest

Requires Authentication
The following routes are available for this service:
PATCH,PUT,OPTIONS/v1/records/series/{SeriesId}
POST,OPTIONS/v1/records/series
"use strict";
export class RecordsOkResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Ok?:boolean,Id?:number,Key?:string,Matches?:string[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {boolean} */
    Ok;
    /** @type {number} */
    Id;
    /** @type {string} */
    Key;
    /** @type {string[]} */
    Matches = [];
}
export class RecordSeriesSaveRequest {
    /** @param {{SeriesId?:number,Code?:string,Name?:string,Years?:number,Permanent?:boolean,RetClass?:string,TriggerEvent?:string,Method?:string,ImageAndDestroy?:boolean,Citation?:string,FieldsJson?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    SeriesId;
    /** @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;
}

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

<RecordSeriesSaveRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Citation>String</Citation>
  <Code>String</Code>
  <FieldsJson>String</FieldsJson>
  <ImageAndDestroy>false</ImageAndDestroy>
  <Method>String</Method>
  <Name>String</Name>
  <Permanent>false</Permanent>
  <RetClass>String</RetClass>
  <SeriesId>0</SeriesId>
  <TriggerEvent>String</TriggerEvent>
  <Years>0</Years>
</RecordSeriesSaveRequest>

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

<RecordsOkResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Id>0</Id>
  <Key>String</Key>
  <Matches xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Matches>
  <Ok>false</Ok>
  <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>
</RecordsOkResponse>