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:

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.

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™.

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.

REMOVE ACCOUNT

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

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 CHILDREN

...

Child pages (Children Display)

...

CONNECT TO A TRACK

Connects an account to a track in dialogportal™

DISCONNECT FROM A TRACK

Disconnects an account from a track. The connection between the account and the track is not removed, but the state of it identifies it as broken.

ENUMERATE TRACKS

Retrieves an enumeration of all the tracks an account is connected to.

DETERMINE TRACK CONNECTION

Determines if an account is connected to a track

SEARCH

...

styleh3
sorttitle
excerpttrue