Account Template APIs

Get Account Template (GET)

Gets the complete content of the account template with the desired template <paramref name="id"/>.

Route

URI	/api/v1/account/template
Method	GET
Result	JSON – AccountTemplateFieldModel

Parameters

Name	Type	Mandatory	Description
id	Guid	No	Template ID

Response Structure Returns AccountTemplateFieldModel object containing:

- Properties: KeyValuePair<string, string>[] value

Example

GET http://localhost/api/v1/account/template

Example Response

{     "Properties": {} }

Validate Account Template (POST)

Returns the sandbox result of the template based account creation.

Route

URI	/api/v1/account/template/{id}
Method	POST
Result	JSON – TemplateValidationResultModel

Parameters

Name	Type	Mandatory	Description
id	Guid	Yes	Template ID
content	AccountTemplateModel	No	Defined template values with keys

Response Structure Returns TemplateValidationResultModel object containing:

• Successful: bool value

• ValidationDetails: KeyValuePair<string, string>[] value

Example

POST http://localhost/api/v1/account/template/{id}

Example Response

{     "Successful": true,     "ValidationDetails": {} }

Get Account Template2 (GET)

Gets the complete content of the account template with the desired template <paramref name="id"/>.

Route

URI	/api/v1/account/template/{id}
Method	GET
Result	JSON – AccountTemplateFieldModel

Parameters

Name	Type	Mandatory	Description
id	Guid	Yes	Template ID

Response Structure Returns AccountTemplateFieldModel object containing:

• Properties: KeyValuePair<string, string>[] value

Example

GET http://localhost/api/v1/account/template/{id}

Example Response

{     "Properties": {} }

Process Account Template (POST)

Processes the creation template according to the desired mode.

Route

URI	/api/v1/account/template/process/{id}
Method	POST
Result	JSON – IActionResult

Parameters

Name	Type	Mandatory	Description
id	Guid	Yes	Template ID
content	AccountTemplateModel	No	Defined template values with keys

Example

POST http://localhost/api/v1/account/template/process/{id}

Get Account Template Infos (GET)

Gets all <see cref="AccountTemplateInfoModel"/> objects for the desired <paramref name="fqdn"/>.

Route

URI	/api/v1/account/templates
Method	GET
Result	JSON – AccountTemplateInfoModel[]

Parameters

Name	Type	Mandatory	Description
fqdn	string	No	The full qualified domain name scope of the templates. if null all templates are reported.

Response Structure Returns AccountTemplateInfoModel[] object containing:

• Id: Guid value

• DisplayName: string value

• Description: string value

• FullyQualifiedDomainName: string value

Example

GET http://localhost/api/v1/account/templates

Example Response

{     "Id": "123e4567-e89b-12d3-a456-426614174000",     "DisplayName": "sample",     "Description": "sample",     "FullyQualifiedDomainName": "sample" }

Process Account Template (PUT)

Processes the creation template according to the desired mode.

Route

URI	/api/v2/accounts/templates/{id}
Method	PUT
Result	JSON – IActionResult

Parameters

Name	Type	Mandatory	Description
id	Guid	Yes	Template ID
content	AccountTemplateModel	No	Defined template values with keys

Example

PUT http://localhost/api/v2/accounts/templates/{id}