Trendsic Platform Service

HoldsRequest

The following routes are available for this service:
GET,OPTIONS	/v1/records/holds

**HoldsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No
Holds	form	List<LegalHoldDto>	No

**LegalHoldDto** Parameters:
Name	Parameter	Data Type	Required
HoldId	form	int	No
HoldKey	form	string	No
Name	form	string	No
Matter	form	string	No
ScopeDim	form	string	No
ScopeVal	form	string	No
ScopeLabel	form	string	No
ScopeNote	form	string	No
PlacedBy	form	string	No
PlacedLabel	form	string	No
Released	form	bool	No
ReleasedLabel	form	string	No
FrozenJson	form	string	No
LogJson	form	string	No
Matches	form	List<HoldMatchDto>	No

**HoldMatchDto** Parameters:
Name	Parameter	Data Type	Required
RecordKey	form	string	No
Name	form	string	No
Tag	form	string	No
Warn	form	bool	No

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

HTTP + JSV

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: text/jsv

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