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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<ProvisionTenantRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AssignMeAsOwner>false</AssignMeAsOwner>
  <BranchName>String</BranchName>
  <Name>String</Name>
  <OwnerEmail>String</OwnerEmail>
  <PackCode>String</PackCode>
  <SeedCatalog>false</SeedCatalog>
  <Slug>String</Slug>
  <TimeZoneId>String</TimeZoneId>
</ProvisionTenantRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ProvisionResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <BranchId>00000000-0000-0000-0000-000000000000</BranchId>
  <BranchName>String</BranchName>
  <CatalogItemsSeeded>0</CatalogItemsSeeded>
  <OwnerAssigned>false</OwnerAssigned>
  <OwnerEmail>String</OwnerEmail>
  <PackCode>String</PackCode>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <RolesCreated xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </RolesCreated>
  <Slug>String</Slug>
  <TenantId>00000000-0000-0000-0000-000000000000</TenantId>
  <TenantName>String</TenantName>
</ProvisionResult>