Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

dialogportal™ REST API contains a number of end points to manage user accounts. The following end points are available:

1001: Create account

Creates a new user account in the dialogportal™ database with fields specified in a contract between the calling application and dialogportal™. dialogportal™ automatically assigns a unique key for the new account and optionally a key with an external type.

1002: Get account data

Retrieves data for an account. The returned data will always contain dialogportal™ master key and optionally a key with an external type. In addition, the payload contains the data specified in the contract between the calling application and dialogportal™.

1003: Update account data

Validates that the data complies with possible rules and performs the update if it does. Only the data provided in the payload is updated. The calling application must have permission to update accounts.

1004: Remove account

Deletes an account. The calling application must have permission to delete accounts.

1005: Create child

Creates a new account as a child of another account in the dialogportal™ database with fields specified in a contract between the calling application and dialogportal™. The parentchild relationship between the accounts must be previously established in dialogportal™.

ENUMERATE CHILDREN1006: Enumerate children

Retrieves all the children for an account. The returned data will always contain the dialogportal™ master key 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 dialogportal™.

...