| Action: | GET | |||||||||||||||||||||||||||||||||||||||||||
| Method: | GET | |||||||||||||||||||||||||||||||||||||||||||
| URL: | /api/v1/client/MatchDocument/get | |||||||||||||||||||||||||||||||||||||||||||
| Description: | Fetch Document based on document id with some additional parameters | |||||||||||||||||||||||||||||||||||||||||||
| Type | Key | DataType | Notes | |||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Headers | api-key | String | Your Api-Key | |||||||||||||||||||||||||||||||||||||||||
| Params | BusinessUnitID | Int32 | Business Unit Identifier (optional - value defaulted to 10 if not provided) | |||||||||||||||||||||||||||||||||||||||||
| Params | ClientEntityID | Int32 | Client Entity Identifier | |||||||||||||||||||||||||||||||||||||||||
| Params | EntityID | Int32 | Entity Identifier | |||||||||||||||||||||||||||||||||||||||||
| Params | IncludeFileData | Boolean | Include File Data | |||||||||||||||||||||||||||||||||||||||||
| Params | AzureDocID | String | Azure Document Identifier | |||||||||||||||||||||||||||||||||||||||||
| Params | ActionUserID | Int32 | Identifier of the User performing action. | |||||||||||||||||||||||||||||||||||||||||
| Params | ReturnFormat | String | Json or Xml | |||||||||||||||||||||||||||||||||||||||||
| Return Data: |
Json or XML of document response { "ClientEntityID": 1234, "ClientEntityInterfaceReference": "ABCD-1234", "ClientEntityLastName": "PUTIN", "ClientEntityFirstName": "VLADIMIR", "ClientEntityMiddleName": "", "EntityID": 1234, "EntityFullName": "ABC PQR XYZ", "EntityLastName": "XYZ", "EntityFirstName": "ABC", "EntityMiddleName": "PQR", "AzureDocID": "ABCD-1234", "ClientAzureTenantID": "ABCD-1234", "DocumentName": "dummy.png", "MediaType": "image/png", "DocumentData": [], "DateLastChanged": "2099-12-31 00:00:00", "LastChangedByUserID": "123" "LastChangedUserName": "XYZ" "DataSourceProvider": "123" } |
|
||||||||||||||||||||||||||||||||||||||||||