Trendsic Platform Service

<back to all web services

ProvisionTenantRequest

Requires Authentication
The following routes are available for this service:
POST/v1/provision
"use strict";
export class ProvisionResult {
    /** @param {{TenantId?:string,TenantName?:string,Slug?:string,PackCode?:string,BranchId?:string,BranchName?:string,RolesCreated?:string[],CatalogItemsSeeded?:number,OwnerAssigned?:boolean,OwnerEmail?:string,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    TenantId;
    /** @type {string} */
    TenantName;
    /** @type {string} */
    Slug;
    /** @type {string} */
    PackCode;
    /** @type {string} */
    BranchId;
    /** @type {string} */
    BranchName;
    /** @type {string[]} */
    RolesCreated = [];
    /** @type {number} */
    CatalogItemsSeeded;
    /** @type {boolean} */
    OwnerAssigned;
    /** @type {string} */
    OwnerEmail;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class ProvisionTenantRequest {
    /** @param {{Name?:string,Slug?:string,PackCode?:string,BranchName?:string,TimeZoneId?:string,SeedCatalog?:boolean,AssignMeAsOwner?:boolean,OwnerEmail?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Name;
    /** @type {string} */
    Slug;
    /** @type {string} */
    PackCode;
    /** @type {string} */
    BranchName;
    /** @type {string} */
    TimeZoneId;
    /** @type {boolean} */
    SeedCatalog;
    /** @type {boolean} */
    AssignMeAsOwner;
    /** @type {string} */
    OwnerEmail;
}

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

{
	Name: String,
	Slug: String,
	PackCode: String,
	BranchName: String,
	TimeZoneId: String,
	SeedCatalog: False,
	AssignMeAsOwner: False,
	OwnerEmail: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	TenantId: 00000000000000000000000000000000,
	TenantName: String,
	Slug: String,
	PackCode: String,
	BranchId: 00000000000000000000000000000000,
	BranchName: String,
	RolesCreated: 
	[
		String
	],
	CatalogItemsSeeded: 0,
	OwnerAssigned: False,
	OwnerEmail: String,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}