Trendsic Platform Service

<back to all web services

HoldsRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/records/holds
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 HoldMatchDto() = 
        member val RecordKey:String = null with get,set
        member val Name:String = null with get,set
        member val Tag:String = null with get,set
        member val Warn:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type LegalHoldDto() = 
        member val HoldId:Int32 = new Int32() with get,set
        member val HoldKey:String = null with get,set
        member val Name:String = null with get,set
        member val Matter:String = null with get,set
        member val ScopeDim:String = null with get,set
        member val ScopeVal:String = null with get,set
        member val ScopeLabel:String = null with get,set
        member val ScopeNote:String = null with get,set
        member val PlacedBy:String = null with get,set
        member val PlacedLabel:String = null with get,set
        member val Released:Boolean = new Boolean() with get,set
        member val ReleasedLabel:String = null with get,set
        member val FrozenJson:String = null with get,set
        member val LogJson:String = null with get,set
        member val Matches:ResizeArray<HoldMatchDto> = new ResizeArray<HoldMatchDto>() with get,set

    [<AllowNullLiteral>]
    type HoldsResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Holds:ResizeArray<LegalHoldDto> = new ResizeArray<LegalHoldDto>() with get,set

    [<AllowNullLiteral>]
    type HoldsRequest() = 
        class end

F# HoldsRequest 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/holds 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"}},"Holds":[{"HoldId":0,"HoldKey":"String","Name":"String","Matter":"String","ScopeDim":"String","ScopeVal":"String","ScopeLabel":"String","ScopeNote":"String","PlacedBy":"String","PlacedLabel":"String","Released":false,"ReleasedLabel":"String","FrozenJson":"String","LogJson":"String","Matches":[{"RecordKey":"String","Name":"String","Tag":"String","Warn":false}]}]}