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 'package:servicestack/servicestack.dart';

class RecordsOkResponse implements IConvertible
{
    ResponseStatus? ResponseStatus;
    bool? Ok;
    int? Id;
    String? Key;
    List<String>? Matches = [];

    RecordsOkResponse({this.ResponseStatus,this.Ok,this.Id,this.Key,this.Matches});
    RecordsOkResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        Ok = json['Ok'];
        Id = json['Id'];
        Key = json['Key'];
        Matches = JsonConverters.fromJson(json['Matches'],'List<String>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!),
        'Ok': Ok,
        'Id': Id,
        'Key': Key,
        'Matches': JsonConverters.toJson(Matches,'List<String>',context!)
    };

    getTypeName() => "RecordsOkResponse";
    TypeContext? context = _ctx;
}

class HoldPlaceRequest implements IConvertible
{
    String? Name;
    String? Matter;
    String? ScopeDim;
    String? ScopeVal;
    bool? DryRun;

    HoldPlaceRequest({this.Name,this.Matter,this.ScopeDim,this.ScopeVal,this.DryRun});
    HoldPlaceRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Name = json['Name'];
        Matter = json['Matter'];
        ScopeDim = json['ScopeDim'];
        ScopeVal = json['ScopeVal'];
        DryRun = json['DryRun'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Name': Name,
        'Matter': Matter,
        'ScopeDim': ScopeDim,
        'ScopeVal': ScopeVal,
        'DryRun': DryRun
    };

    getTypeName() => "HoldPlaceRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'api.dev.dynamics.trendsic.com', types: <String, TypeInfo> {
    'RecordsOkResponse': TypeInfo(TypeOf.Class, create:() => RecordsOkResponse()),
    'HoldPlaceRequest': TypeInfo(TypeOf.Class, create:() => HoldPlaceRequest()),
});

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

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

{
	Name: String,
	Matter: String,
	ScopeDim: String,
	ScopeVal: String,
	DryRun: False
}
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
		}
	},
	Ok: False,
	Id: 0,
	Key: String,
	Matches: 
	[
		String
	]
}