Trendsic Platform Service

<back to all web services

HoldPlaceRequest

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


open class HoldPlaceRequest
{
    open var Name:String? = null
    open var Matter:String? = null
    open var ScopeDim:String? = null
    open var ScopeVal:String? = null
    open var DryRun:Boolean? = null
}

open class RecordsOkResponse
{
    open var ResponseStatus:ResponseStatus? = null
    open var Ok:Boolean? = null
    open var Id:Int? = null
    open var Key:String? = null
    open var Matches:ArrayList<String> = ArrayList<String>()
}

Kotlin HoldPlaceRequest 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.

POST /v1/records/holds HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<HoldPlaceRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <DryRun>false</DryRun>
  <Matter>String</Matter>
  <Name>String</Name>
  <ScopeDim>String</ScopeDim>
  <ScopeVal>String</ScopeVal>
</HoldPlaceRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<RecordsOkResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Id>0</Id>
  <Key>String</Key>
  <Matches xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Matches>
  <Ok>false</Ok>
  <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>
</RecordsOkResponse>