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
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class RecordSeriesSaveRequest
    {
        public Integer SeriesId = null;
        public String Code = null;
        public String Name = null;
        public Integer Years = null;
        public Boolean Permanent = null;
        public String RetClass = null;
        public String TriggerEvent = null;
        public String Method = null;
        public Boolean ImageAndDestroy = null;
        public String Citation = null;
        public String FieldsJson = null;
        
        public Integer getSeriesId() { return SeriesId; }
        public RecordSeriesSaveRequest setSeriesId(Integer value) { this.SeriesId = value; return this; }
        public String getCode() { return Code; }
        public RecordSeriesSaveRequest setCode(String value) { this.Code = value; return this; }
        public String getName() { return Name; }
        public RecordSeriesSaveRequest setName(String value) { this.Name = value; return this; }
        public Integer getYears() { return Years; }
        public RecordSeriesSaveRequest setYears(Integer value) { this.Years = value; return this; }
        public Boolean isPermanent() { return Permanent; }
        public RecordSeriesSaveRequest setPermanent(Boolean value) { this.Permanent = value; return this; }
        public String getRetClass() { return RetClass; }
        public RecordSeriesSaveRequest setRetClass(String value) { this.RetClass = value; return this; }
        public String getTriggerEvent() { return TriggerEvent; }
        public RecordSeriesSaveRequest setTriggerEvent(String value) { this.TriggerEvent = value; return this; }
        public String getMethod() { return Method; }
        public RecordSeriesSaveRequest setMethod(String value) { this.Method = value; return this; }
        public Boolean isImageAndDestroy() { return ImageAndDestroy; }
        public RecordSeriesSaveRequest setImageAndDestroy(Boolean value) { this.ImageAndDestroy = value; return this; }
        public String getCitation() { return Citation; }
        public RecordSeriesSaveRequest setCitation(String value) { this.Citation = value; return this; }
        public String getFieldsJson() { return FieldsJson; }
        public RecordSeriesSaveRequest setFieldsJson(String value) { this.FieldsJson = value; return this; }
    }

    public static class RecordsOkResponse
    {
        public ResponseStatus ResponseStatus = null;
        public Boolean Ok = null;
        public Integer Id = null;
        public String Key = null;
        public ArrayList<String> Matches = new ArrayList<String>();
        
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public RecordsOkResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
        public Boolean isOk() { return Ok; }
        public RecordsOkResponse setOk(Boolean value) { this.Ok = value; return this; }
        public Integer getId() { return Id; }
        public RecordsOkResponse setId(Integer value) { this.Id = value; return this; }
        public String getKey() { return Key; }
        public RecordsOkResponse setKey(String value) { this.Key = value; return this; }
        public ArrayList<String> getMatches() { return Matches; }
        public RecordsOkResponse setMatches(ArrayList<String> value) { this.Matches = value; return this; }
    }

}

Java 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>