Versions Compared

Old Version 5

changes.mady.by.user Usman Tanveer

Saved on

compared with

New Version 6

changes.mady.by.user Nick Jensen

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Renumber endpoints 106x to 920x
Excerpt

Retrieves document for an account.


Endpoint ID:

10609200
Method:
Status
colourGreen
titleGET
URL:

/user/dp-key/{entityID}/documents/{documentID}

/user/ext-key/{externalRelationID}/{externalRelationType}/documents/{documentID}



entityID

dialogportal™ master key that uniquely identifies account to return data for


externalRelationID

External key that uniquely identifies account to return data for


externalRelationType

Type of external key


documentIDThe ID of the document to be retrieved
Request body:None
Span
stylewhite-space:pre
Response body:

JSON data with properties corresponding to the document.

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

Code Block
titleExample Response
{
	"content": 123456,
	"compressed": "John Doe",
	"createdBy": "mailbox@mailserver.com",
	"createdDate": "01-01-2016 12:00:00",
	"description": "Description of the document",
	"documentID": 1,
	"expiryDate": "31-12-2016 23:59:59",
	"mimeType": "image",
	"name": "Test Document",
	"sizeCompressed": 500,
	"sizeOriginal": 1500,
	"srid": 12345,
	"updatedBy": "mailbox@mailserver.com",
	"updatedDate": "01-03-2016 12:00:00"
}
Status codes:200

Document 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