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.*;

public class dtos
{

    public static class HoldPlaceRequest
    {
        public String Name = null;
        public String Matter = null;
        public String ScopeDim = null;
        public String ScopeVal = null;
        public Boolean DryRun = null;
        
        public String getName() { return Name; }
        public HoldPlaceRequest setName(String value) { this.Name = value; return this; }
        public String getMatter() { return Matter; }
        public HoldPlaceRequest setMatter(String value) { this.Matter = value; return this; }
        public String getScopeDim() { return ScopeDim; }
        public HoldPlaceRequest setScopeDim(String value) { this.ScopeDim = value; return this; }
        public String getScopeVal() { return ScopeVal; }
        public HoldPlaceRequest setScopeVal(String value) { this.ScopeVal = value; return this; }
        public Boolean isDryRun() { return DryRun; }
        public HoldPlaceRequest setDryRun(Boolean value) { this.DryRun = value; return this; }
    }

    public static class RecordsOkResponse
    {
        public ResponseStatus ResponseStatus = null;
        public Boolean Ok = null;
        public Integer Id = null;
        public String Key = null;
        public ArrayList<String> Matches = new ArrayList<String>();
        
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public RecordsOkResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
        public Boolean isOk() { return Ok; }
        public RecordsOkResponse setOk(Boolean value) { this.Ok = value; return this; }
        public Integer getId() { return Id; }
        public RecordsOkResponse setId(Integer value) { this.Id = value; return this; }
        public String getKey() { return Key; }
        public RecordsOkResponse setKey(String value) { this.Key = value; return this; }
        public ArrayList<String> getMatches() { return Matches; }
        public RecordsOkResponse setMatches(ArrayList<String> value) { this.Matches = value; return this; }
    }

}

Java 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>