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 .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/holds HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<HoldsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Holds>
    <LegalHoldDto>
      <FrozenJson>String</FrozenJson>
      <HoldId>0</HoldId>
      <HoldKey>String</HoldKey>
      <LogJson>String</LogJson>
      <Matches>
        <HoldMatchDto>
          <Name>String</Name>
          <RecordKey>String</RecordKey>
          <Tag>String</Tag>
          <Warn>false</Warn>
        </HoldMatchDto>
      </Matches>
      <Matter>String</Matter>
      <Name>String</Name>
      <PlacedBy>String</PlacedBy>
      <PlacedLabel>String</PlacedLabel>
      <Released>false</Released>
      <ReleasedLabel>String</ReleasedLabel>
      <ScopeDim>String</ScopeDim>
      <ScopeLabel>String</ScopeLabel>
      <ScopeNote>String</ScopeNote>
      <ScopeVal>String</ScopeVal>
    </LegalHoldDto>
  </Holds>
  <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>
</HoldsResponse>