Trendsic Platform Service

<back to all web services

RecordsSearchRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/records/search
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class RecordsSearchRequest
    {
        public String Q = null;
        public Integer Page = null;
        public Integer PageSize = null;
        
        public String getQ() { return Q; }
        public RecordsSearchRequest setQ(String value) { this.Q = value; return this; }
        public Integer getPage() { return Page; }
        public RecordsSearchRequest setPage(Integer value) { this.Page = value; return this; }
        public Integer getPageSize() { return PageSize; }
        public RecordsSearchRequest setPageSize(Integer value) { this.PageSize = value; return this; }
    }

    public static class RecordsSearchResponse
    {
        public ResponseStatus ResponseStatus = null;
        public ArrayList<RecordDto> Records = new ArrayList<RecordDto>();
        
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public RecordsSearchResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
        public ArrayList<RecordDto> getRecords() { return Records; }
        public RecordsSearchResponse setRecords(ArrayList<RecordDto> value) { this.Records = value; return this; }
    }

    public static class RecordDto
    {
        public Integer RecordId = null;
        public String RecordKey = null;
        public String Name = null;
        public Integer SeriesId = null;
        public String SeriesKey = null;
        public String Classification = null;
        public String Format = null;
        public String Phase = null;
        public String TriggerDate = null;
        public Boolean Staged = null;
        public Integer HoldId = null;
        public String HoldKey = null;
        public String OwnerName = null;
        public String Branch = null;
        public String Barcode = null;
        public String LocJson = null;
        public String MetaJson = null;
        public String FilesJson = null;
        public String VersionsJson = null;
        public String RelatedJson = null;
        public String DisposedJson = null;
        public String CreatedLabel = null;
        public String UpdatedLabel = null;
        public String Lifecycle = null;
        public String RetKind = null;
        public String EligibleDate = null;
        public Integer MonthsLeft = null;
        
        public Integer getRecordId() { return RecordId; }
        public RecordDto setRecordId(Integer value) { this.RecordId = value; return this; }
        public String getRecordKey() { return RecordKey; }
        public RecordDto setRecordKey(String value) { this.RecordKey = value; return this; }
        public String getName() { return Name; }
        public RecordDto setName(String value) { this.Name = value; return this; }
        public Integer getSeriesId() { return SeriesId; }
        public RecordDto setSeriesId(Integer value) { this.SeriesId = value; return this; }
        public String getSeriesKey() { return SeriesKey; }
        public RecordDto setSeriesKey(String value) { this.SeriesKey = value; return this; }
        public String getClassification() { return Classification; }
        public RecordDto setClassification(String value) { this.Classification = value; return this; }
        public String getFormat() { return Format; }
        public RecordDto setFormat(String value) { this.Format = value; return this; }
        public String getPhase() { return Phase; }
        public RecordDto setPhase(String value) { this.Phase = value; return this; }
        public String getTriggerDate() { return TriggerDate; }
        public RecordDto setTriggerDate(String value) { this.TriggerDate = value; return this; }
        public Boolean isStaged() { return Staged; }
        public RecordDto setStaged(Boolean value) { this.Staged = value; return this; }
        public Integer getHoldId() { return HoldId; }
        public RecordDto setHoldId(Integer value) { this.HoldId = value; return this; }
        public String getHoldKey() { return HoldKey; }
        public RecordDto setHoldKey(String value) { this.HoldKey = value; return this; }
        public String getOwnerName() { return OwnerName; }
        public RecordDto setOwnerName(String value) { this.OwnerName = value; return this; }
        public String getBranch() { return Branch; }
        public RecordDto setBranch(String value) { this.Branch = value; return this; }
        public String getBarcode() { return Barcode; }
        public RecordDto setBarcode(String value) { this.Barcode = value; return this; }
        public String getLocJson() { return LocJson; }
        public RecordDto setLocJson(String value) { this.LocJson = value; return this; }
        public String getMetaJson() { return MetaJson; }
        public RecordDto setMetaJson(String value) { this.MetaJson = value; return this; }
        public String getFilesJson() { return FilesJson; }
        public RecordDto setFilesJson(String value) { this.FilesJson = value; return this; }
        public String getVersionsJson() { return VersionsJson; }
        public RecordDto setVersionsJson(String value) { this.VersionsJson = value; return this; }
        public String getRelatedJson() { return RelatedJson; }
        public RecordDto setRelatedJson(String value) { this.RelatedJson = value; return this; }
        public String getDisposedJson() { return DisposedJson; }
        public RecordDto setDisposedJson(String value) { this.DisposedJson = value; return this; }
        public String getCreatedLabel() { return CreatedLabel; }
        public RecordDto setCreatedLabel(String value) { this.CreatedLabel = value; return this; }
        public String getUpdatedLabel() { return UpdatedLabel; }
        public RecordDto setUpdatedLabel(String value) { this.UpdatedLabel = value; return this; }
        public String getLifecycle() { return Lifecycle; }
        public RecordDto setLifecycle(String value) { this.Lifecycle = value; return this; }
        public String getRetKind() { return RetKind; }
        public RecordDto setRetKind(String value) { this.RetKind = value; return this; }
        public String getEligibleDate() { return EligibleDate; }
        public RecordDto setEligibleDate(String value) { this.EligibleDate = value; return this; }
        public Integer getMonthsLeft() { return MonthsLeft; }
        public RecordDto setMonthsLeft(Integer value) { this.MonthsLeft = value; return this; }
    }

}

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