Retrieving a Document Resource

Description

This web service returns all the documents of the required user.

Definition

GET https://<domain>/services/apexrest/peer/v1/Document/*

Parameters

The table given below provides details of the request parameter used by this web service:

Field	Type	Description
platformId*	String	This is the account ID of the user

Error messages

When you post a web service, you can receive the possible error messages as shown in the table below:

Error Code	Reason	HTTP Status Code
ACCOUNT_NOT_FOUND	You will receive this error if the requested account ID is not found.	400
DOCUMENT_NOT_FOUND	You will receive this error if the requested document is not found.	400
<exception message>	You will receive this error if there is any run time exception.	500

Sample Request

The sample request to be sent is as shown below:

https://na11.salesforce.com/services/apexrest/peer/v1/document/getRequiredDoc?accountId=001G000001Phdoe

Sample Response

The sample response that you will receive is as shown below:

{
   "status":"SUCCESS",
   "response":[
      {
         "uploadDocsCount":3,
         "uploadDocs":[
            {
               "uploaded":false,
               "Name":"חשבון בנק אחרון",
               "Id":"2"            },
            {
               "uploaded":false,
               "Name":"תעודת זהות",
               "Id":"1"            },
            {
               "uploaded":false,
               "Name":"חתימה דיגיטלית",
               "Id":"999"            }
         ],
         "error_Message":null
      }
   ],
   "errorCode":"NO_ERROR",
   "content":[

   ]
}