Trendsic Platform Service

<back to all web services

HoldsRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/records/holds
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CRM.AgencyPlatform.API.Internal;

namespace CRM.AgencyPlatform.API.Internal
{
    public partial class HoldMatchDto
    {
        public virtual string RecordKey { get; set; }
        public virtual string Name { get; set; }
        public virtual string Tag { get; set; }
        public virtual bool Warn { get; set; }
    }

    public partial class HoldsRequest
    {
    }

    public partial class HoldsResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual List<LegalHoldDto> Holds { get; set; } = [];
    }

    public partial class LegalHoldDto
    {
        public virtual int HoldId { get; set; }
        public virtual string HoldKey { get; set; }
        public virtual string Name { get; set; }
        public virtual string Matter { get; set; }
        public virtual string ScopeDim { get; set; }
        public virtual string ScopeVal { get; set; }
        public virtual string ScopeLabel { get; set; }
        public virtual string ScopeNote { get; set; }
        public virtual string PlacedBy { get; set; }
        public virtual string PlacedLabel { get; set; }
        public virtual bool Released { get; set; }
        public virtual string ReleasedLabel { get; set; }
        public virtual string FrozenJson { get; set; }
        public virtual string LogJson { get; set; }
        public virtual List<HoldMatchDto> Matches { get; set; } = [];
    }

}

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