Trendsic Platform Service

HoldsRequest

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

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class HoldMatchDto:
    record_key: Optional[str] = None
    name: Optional[str] = None
    tag: Optional[str] = None
    warn: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class LegalHoldDto:
    hold_id: int = 0
    hold_key: Optional[str] = None
    name: Optional[str] = None
    matter: Optional[str] = None
    scope_dim: Optional[str] = None
    scope_val: Optional[str] = None
    scope_label: Optional[str] = None
    scope_note: Optional[str] = None
    placed_by: Optional[str] = None
    placed_label: Optional[str] = None
    released: bool = False
    released_label: Optional[str] = None
    frozen_json: Optional[str] = None
    log_json: Optional[str] = None
    matches: List[HoldMatchDto] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class HoldsResponse:
    response_status: Optional[ResponseStatus] = None
    holds: List[LegalHoldDto] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class HoldsRequest:
    pass

Python HoldsRequest DTOs

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