Versions Compared

Old Version 9

changes.mady.by.user Troels Nielsen

Saved on

compared with

New Version Current

changes.mady.by.user Nick Jensen

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Use /entity routing instead of /user


Excerpt

Retrieves data for an entity/account. The returned data will always contain the Rubiq entity ID and optionally a key with an external type. In addition, the payload contains the data specified in the contract between the calling application and the Rubiq API.




Span
stylewhite-space: pre
Endpoint ID:


1002
Method:
Status
colourGreen
titleGET
URL:

/userentity/dp-keyid/{dpentity-keyid}/data/{contract-id}

/userentity/ext-key/{ext-key}/{ext-type}/data/{contract-id}


 

dpentity-keydialogportal™ master key id

Rubiq entity ID that uniquely identifies an account to return data for


 

ext-key

External key that uniquely identifies an account to return data for


 

ext-type

Type of external key


 

contract-id

Identifies the set of contract fields to return. If omitted, the default contract for the particular app is used.

Request body:None 


Span
stylewhite-space:pre
Response body:


JSON data with properties corresponding to the fields in the specified contract. The result will always hold the dialogportal™ master key 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.

Please note that fields with null value is not returned by this end point.

Code Block
titleExample 1 - Contract specifies full name and email:
{
	"dpKeyid": 123456,
	"name": "John Doe",
	"email": "mailbox@mailserver.com"
}


Status codes:200

Account found with success

 

404

Account was not found

The following sub codes may be returned:

404.1User not found
404.2External user could not be found