Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

Endpoint ID:1005
Method:POST
URL:

/user/dp-key/{dp-key}/child/{contract-id}

/user/ext-key/{ext-key}/{ext-type}/child/{contract-id}

 

 

dp-key

dialogportal™ master key that uniquely identifies account that will be the parent of the new child

 ext-key

External key that uniquely identifies account that will be the parent of the new child

 ext-typeType of external key
 contract-id

Identifies the type of child to create and the set of contract fields passed in the request body

Request body:

 JSON data with properties corresponding to the fields in the specified contract

Example 1 - Contract specifies first name, last name and gender:
{
	"firstName": "John",
	"lastName": "Doe",
	"gender": "Male"
}

Response body:

JSON data with key(s) for the newly created account and data for the account. The result will always hold the dialogportal™ master key and if the app making the request is configured to use a specific external key, this key is also included in the response.

Example 1 – App setting specifies no specific key:
{
	"dpKey": 123456
	"firstName": "John",
	"lastName": "Doe",
	"gender": "Male"
}
Example 2 – App setting specifies external key type:
{
	"dpKey": 123456,
	"extKeyType": 12,
	"extKey": "key",
	"firstName": "John",
	"lastName": "Doe",
	"gender": "Male"
}
Status codes:

201

Child was created with success
 303Child already exists, redirected to “Get Account Data”
 400Request is valid but data validation failed
  • No labels