Trendsic Platform Service

RecordsSearchRequest

The following routes are available for this service:
GET,OPTIONS	/v1/records/search


export class RecordDto
{
    public RecordId: number;
    public RecordKey: string;
    public Name: string;
    public SeriesId?: number;
    public SeriesKey: string;
    public Classification: string;
    public Format: string;
    public Phase: string;
    public TriggerDate: string;
    public Staged: boolean;
    public HoldId?: number;
    public HoldKey: string;
    public OwnerName: string;
    public Branch: string;
    public Barcode: string;
    public LocJson: string;
    public MetaJson: string;
    public FilesJson: string;
    public VersionsJson: string;
    public RelatedJson: string;
    public DisposedJson: string;
    public CreatedLabel: string;
    public UpdatedLabel: string;
    public Lifecycle: string;
    public RetKind: string;
    public EligibleDate: string;
    public MonthsLeft: number;

    public constructor(init?: Partial<RecordDto>) { (Object as any).assign(this, init); }
}

export class RecordsSearchResponse
{
    public ResponseStatus: ResponseStatus;
    public Records: RecordDto[] = [];

    public constructor(init?: Partial<RecordsSearchResponse>) { (Object as any).assign(this, init); }
}

export class RecordsSearchRequest
{
    public Q: string;
    public Page: number;
    public PageSize: number;

    public constructor(init?: Partial<RecordsSearchRequest>) { (Object as any).assign(this, init); }
}

TypeScript RecordsSearchRequest 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/search 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>