Trendsic Platform Service

<back to all web services

TermOverrideRequest

Requires Authentication
The following routes are available for this service:
POST,DELETE,OPTIONS/v1/terminology/override
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type IndustryPack() = 
        member val PackId:Guid = new Guid() with get,set
        member val Code:String = null with get,set
        member val Name:String = null with get,set
        member val IsActive:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type TermOverride() = 
        member val TermKey:String = null with get,set
        member val Label:String = null with get,set
        member val CreatedBy:String = null with get,set
        member val CreatedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val UpdatedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set

    [<AllowNullLiteral>]
    type TerminologyAdminResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Packs:ResizeArray<IndustryPack> = new ResizeArray<IndustryPack>() with get,set
        member val SelectedPackId:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val Terms:Dictionary<String, String> = new Dictionary<String, String>() with get,set
        member val Overrides:ResizeArray<TermOverride> = new ResizeArray<TermOverride>() with get,set

    [<AllowNullLiteral>]
    type TermOverrideRequest() = 
        member val TermKey:String = null with get,set
        member val Label:String = null with get,set

F# TermOverrideRequest 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/terminology/override HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	TermKey: String,
	Label: String
}
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
		}
	},
	Packs: 
	[
		{
			PackId: 00000000000000000000000000000000,
			Code: String,
			Name: String,
			IsActive: False
		}
	],
	SelectedPackId: 00000000000000000000000000000000,
	Terms: 
	{
		String: String
	},
	Overrides: 
	[
		{
			TermKey: String,
			Label: String,
			CreatedBy: String,
			CreatedAt: 0001-01-01,
			UpdatedAt: 0001-01-01
		}
	]
}