Versions Compared

Old Version 1

changes.mady.by.user Usman Tanveer

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 documents for an account.


Span
stylewhite-space: pre

Endpoint ID:

1061
9201
Method:
Status
colourGreen
titleGET
URL:

/

user

entity/

dp-key

id/{entityID}/documents

/

user

entity/ext-key/{externalRelationID}/{externalRelationType}/documents


entityID

dialogportal™ master key

Rubiq entity ID that uniquely identifies

account

an account to return data for


externalRelationID

External key that uniquely identifies an account to return data for


externalRelationType

Type of external key

Request body:None
Spanstylewhite-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 and if the app making the request is configured to use a specific external key, this key is also included in the response

documents.

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

Code Block
titleExample Response
[
   
{

      "content":
123456, 
 "base64 encoded text",
      "compressed":
"John Doe", 
 false,
      "createdBy": "mailbox@mailserver.com",

      "createdDate": "01-01-
2016 12
2016T12:00:00",

      "description": "Description of the document",

      "documentID": 1,

      "expiryDate": "31-12-
2016 23
2016T23:59:59",

      "mimeType": "image",

      "name": "Test Document",

      "sizeCompressed": 500,

      "sizeOriginal": 1500,
"srid": 12345, 

      "updatedBy": "mailbox@mailserver.com",

      "updatedDate": "01-03-
2016 12
2016T12:00:00"

   }
]


Status codes:200

Documents found with success


404

Account

/document

was not found

The following sub codes may be returned:

404.1User not found
404.2External user could not be found