Trendsic Platform Service

<back to all web services

RecordsSearchRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/records/search
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type RecordDto() = 
        member val RecordId:Int32 = new Int32() with get,set
        member val RecordKey:String = null with get,set
        member val Name:String = null with get,set
        member val SeriesId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val SeriesKey:String = null with get,set
        member val Classification:String = null with get,set
        member val Format:String = null with get,set
        member val Phase:String = null with get,set
        member val TriggerDate:String = null with get,set
        member val Staged:Boolean = new Boolean() with get,set
        member val HoldId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val HoldKey:String = null with get,set
        member val OwnerName:String = null with get,set
        member val Branch:String = null with get,set
        member val Barcode:String = null with get,set
        member val LocJson:String = null with get,set
        member val MetaJson:String = null with get,set
        member val FilesJson:String = null with get,set
        member val VersionsJson:String = null with get,set
        member val RelatedJson:String = null with get,set
        member val DisposedJson:String = null with get,set
        member val CreatedLabel:String = null with get,set
        member val UpdatedLabel:String = null with get,set
        member val Lifecycle:String = null with get,set
        member val RetKind:String = null with get,set
        member val EligibleDate:String = null with get,set
        member val MonthsLeft:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type RecordsSearchResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Records:ResizeArray<RecordDto> = new ResizeArray<RecordDto>() with get,set

    [<AllowNullLiteral>]
    type RecordsSearchRequest() = 
        member val Q:String = null with get,set
        member val Page:Int32 = new Int32() with get,set
        member val PageSize:Int32 = new Int32() with get,set

F# RecordsSearchRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Records":[{"RecordId":0,"RecordKey":"String","Name":"String","SeriesId":0,"SeriesKey":"String","Classification":"String","Format":"String","Phase":"String","TriggerDate":"String","Staged":false,"HoldId":0,"HoldKey":"String","OwnerName":"String","Branch":"String","Barcode":"String","LocJson":"String","MetaJson":"String","FilesJson":"String","VersionsJson":"String","RelatedJson":"String","DisposedJson":"String","CreatedLabel":"String","UpdatedLabel":"String","Lifecycle":"String","RetKind":"String","EligibleDate":"String","MonthsLeft":0}]}