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

public class dtos
{

    public static class HoldsRequest
    {
        
    }

    public static class HoldsResponse
    {
        public ResponseStatus ResponseStatus = null;
        public ArrayList<LegalHoldDto> Holds = new ArrayList<LegalHoldDto>();
        
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public HoldsResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
        public ArrayList<LegalHoldDto> getHolds() { return Holds; }
        public HoldsResponse setHolds(ArrayList<LegalHoldDto> value) { this.Holds = value; return this; }
    }

    public static class LegalHoldDto
    {
        public Integer HoldId = null;
        public String HoldKey = null;
        public String Name = null;
        public String Matter = null;
        public String ScopeDim = null;
        public String ScopeVal = null;
        public String ScopeLabel = null;
        public String ScopeNote = null;
        public String PlacedBy = null;
        public String PlacedLabel = null;
        public Boolean Released = null;
        public String ReleasedLabel = null;
        public String FrozenJson = null;
        public String LogJson = null;
        public ArrayList<HoldMatchDto> Matches = new ArrayList<HoldMatchDto>();
        
        public Integer getHoldId() { return HoldId; }
        public LegalHoldDto setHoldId(Integer value) { this.HoldId = value; return this; }
        public String getHoldKey() { return HoldKey; }
        public LegalHoldDto setHoldKey(String value) { this.HoldKey = value; return this; }
        public String getName() { return Name; }
        public LegalHoldDto setName(String value) { this.Name = value; return this; }
        public String getMatter() { return Matter; }
        public LegalHoldDto setMatter(String value) { this.Matter = value; return this; }
        public String getScopeDim() { return ScopeDim; }
        public LegalHoldDto setScopeDim(String value) { this.ScopeDim = value; return this; }
        public String getScopeVal() { return ScopeVal; }
        public LegalHoldDto setScopeVal(String value) { this.ScopeVal = value; return this; }
        public String getScopeLabel() { return ScopeLabel; }
        public LegalHoldDto setScopeLabel(String value) { this.ScopeLabel = value; return this; }
        public String getScopeNote() { return ScopeNote; }
        public LegalHoldDto setScopeNote(String value) { this.ScopeNote = value; return this; }
        public String getPlacedBy() { return PlacedBy; }
        public LegalHoldDto setPlacedBy(String value) { this.PlacedBy = value; return this; }
        public String getPlacedLabel() { return PlacedLabel; }
        public LegalHoldDto setPlacedLabel(String value) { this.PlacedLabel = value; return this; }
        public Boolean isReleased() { return Released; }
        public LegalHoldDto setReleased(Boolean value) { this.Released = value; return this; }
        public String getReleasedLabel() { return ReleasedLabel; }
        public LegalHoldDto setReleasedLabel(String value) { this.ReleasedLabel = value; return this; }
        public String getFrozenJson() { return FrozenJson; }
        public LegalHoldDto setFrozenJson(String value) { this.FrozenJson = value; return this; }
        public String getLogJson() { return LogJson; }
        public LegalHoldDto setLogJson(String value) { this.LogJson = value; return this; }
        public ArrayList<HoldMatchDto> getMatches() { return Matches; }
        public LegalHoldDto setMatches(ArrayList<HoldMatchDto> value) { this.Matches = value; return this; }
    }

    public static class HoldMatchDto
    {
        public String RecordKey = null;
        public String Name = null;
        public String Tag = null;
        public Boolean Warn = null;
        
        public String getRecordKey() { return RecordKey; }
        public HoldMatchDto setRecordKey(String value) { this.RecordKey = value; return this; }
        public String getName() { return Name; }
        public HoldMatchDto setName(String value) { this.Name = value; return this; }
        public String getTag() { return Tag; }
        public HoldMatchDto setTag(String value) { this.Tag = value; return this; }
        public Boolean isWarn() { return Warn; }
        public HoldMatchDto setWarn(Boolean value) { this.Warn = value; return this; }
    }

}

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