Trendsic Platform Service

<back to all web services

HoldsRequest

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


open class HoldsRequest
{
}

open class HoldsResponse
{
    open var ResponseStatus:ResponseStatus? = null
    open var Holds:ArrayList<LegalHoldDto> = ArrayList<LegalHoldDto>()
}

open class LegalHoldDto
{
    open var HoldId:Int? = null
    open var HoldKey:String? = null
    open var Name:String? = null
    open var Matter:String? = null
    open var ScopeDim:String? = null
    open var ScopeVal:String? = null
    open var ScopeLabel:String? = null
    open var ScopeNote:String? = null
    open var PlacedBy:String? = null
    open var PlacedLabel:String? = null
    open var Released:Boolean? = null
    open var ReleasedLabel:String? = null
    open var FrozenJson:String? = null
    open var LogJson:String? = null
    open var Matches:ArrayList<HoldMatchDto> = ArrayList<HoldMatchDto>()
}

open class HoldMatchDto
{
    open var RecordKey:String? = null
    open var Name:String? = null
    open var Tag:String? = null
    open var Warn:Boolean? = null
}

Kotlin HoldsRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
HTTP/1.1 200 OK
Content-Type: application/json
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}]}]}