Trendsic Platform Service

<back to all web services

ClientWorkerRestrictionSetRequest

Requires Authentication
The following routes are available for this service:
POST/v1/coverage/restriction
ClientWorkerRestrictionSetRequest Parameters:
NameParameterData TypeRequiredDescription
BranchIdbodyGuid?No
ClientContactIDbodyintNo
WorkerContactIDbodyintNo
RestrictionLevelbodystringNo
ReasonbodystringNo
SourceRatingIDbodyint?No
ClientWorkerRestrictionsResponse Parameters:
NameParameterData TypeRequiredDescription
RestrictionsformList<ClientWorkerRestriction>No
ClientsformList<RestrictionParty>No
WorkersformList<RestrictionParty>No
ResponseStatusformResponseStatusNo
ClientWorkerRestriction Parameters:
NameParameterData TypeRequiredDescription
ClientWorkerRestrictionIDformintNo
BranchIdformGuid?No
ClientContactIDformintNo
WorkerContactIDformintNo
RestrictionLevelformstringNo
ReasonformstringNo
SourceRatingIDformint?No
CreatedByformstringNo
CreatedAtformDateTimeNo
UpdatedAtformDateTime?No
ClientNameformstringNo
WorkerNameformstringNo
LevelLabelformstringNo
RestrictionParty Parameters:
NameParameterData TypeRequiredDescription
ContactIdformintNo
NameformstringNo

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/coverage/restriction HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	BranchId: 00000000000000000000000000000000,
	ClientContactID: 0,
	WorkerContactID: 0,
	RestrictionLevel: String,
	Reason: String,
	SourceRatingID: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Restrictions: 
	[
		{
			ClientWorkerRestrictionID: 0,
			BranchId: 00000000000000000000000000000000,
			ClientContactID: 0,
			WorkerContactID: 0,
			RestrictionLevel: String,
			Reason: String,
			SourceRatingID: 0,
			CreatedBy: String,
			CreatedAt: 0001-01-01,
			UpdatedAt: 0001-01-01,
			ClientName: String,
			WorkerName: String,
			LevelLabel: String
		}
	],
	Clients: 
	[
		{
			ContactId: 0,
			Name: String
		}
	],
	Workers: 
	[
		{
			ContactId: 0,
			Name: String
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}