Trendsic Platform Service

<back to all web services

ContactCategoryRequest

Requires Authentication
Requires any of the roles:Worker, Agent, Administrator
The following routes are available for this service:
GET,PUT,OPTIONS/v1/ContactCategory/
"use strict";
export class ContactCategory {
    /** @param {{Id?:number,Name?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {string} */
    Name;
}
export class ContactCategoryResponse {
    /** @param {{ResponseStatus?:ResponseStatus,ContactCategories?:ContactCategory[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {ContactCategory[]} */
    ContactCategories = [];
}
export class ContactCategoryRequest {
    /** @param {{ContactGUID?:string,CategoryId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ContactGUID;
    /** @type {number} */
    CategoryId;
}

JavaScript ContactCategoryRequest 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.

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

{
	ContactGUID: 00000000000000000000000000000000,
	CategoryId: 0
}
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
		}
	},
	ContactCategories: 
	[
		{
			Id: 0,
			Name: String
		}
	]
}