Excerpt |
---|
Retrieves all the children for an entity/account. The returned data will always contain the Rubiq entity ID and optionally a key with an external type for each of the children. In addition, the payload may optionally contain the data for each child as specified in the contract between the calling application and the Rubiq API. |
Endpoint ID: | 1006 | ||||||||||||||||||||||
Method: |
| ||||||||||||||||||||||
URL: | /userentity/dp-keyid/{dpentity-keyid}/children/data/{contract-id} /userentity/ext-key/{ext-key}/{ext-type}/children/data/{contract-id}
| ||||||||||||||||||||||
dp-key | dialogportal™ master key entity-id | Rubiq entity ID that uniquely identifies an account to enumerate children for | |||||||||||||||||||||
ext-key | External key that uniquely identifies an account to enumerate children for | ||||||||||||||||||||||
ext-type | Type of external key | ||||||||||||||||||||||
contract-id | Identifies the type of children to return and the contract fields to return. If omitted, all child types are returned, each type using the default contract fields for that type | ||||||||||||||||||||||
Request body: | None | ||||||||||||||||||||||
| JSON data with properties corresponding to the fields in the specified contract. The result will always hold the Rubiq entity ID, and if the app making the request is configured to use a specific external key, this key is also included in the response.
| ||||||||||||||||||||||
Status codes: | 200 | Account found with success | |||||||||||||||||||||
404 | Account was not found The following sub codes may be returned:
|