This API will fetch the status of the batchId provided with list of success and error details of each and every user provided in the payload earlier via BulkuploadUsers API. Append the batchId parameter as input for this API.
URL Format: https://api-leoaksuat.gep.com/leo-usermanagement-bulkupload-api/api/v1/leoumbulkupload/getbulkuploadstatus?batchId=GUID
https://api-leoqc.gep.com/leo-invoice-interface/api/v1/InvoiceDetails/Acknowledgement
https://api-leoaksuat.gep.com/leo-usermanagement-bulkupload-api/api/v1/leoumbulkupload/getbulkuploadstatus?batchId=2d528fdc-a88d-446d-a6db-1cafa27cb2af
{
"status": "Success",
"batchId": "2d528fdc-a88d-446d-a6db-1cafa27cb2af",
"successDetails": [
{
"key": "20059265"
},
{
"key": "20059357"
},
{
"key": "20059359"
} ],
"errorDetails": []
}
Return Value | ||||
Property | Required? | Data type | Description | Validations / Exceptions/Values |
status |
| string | Represent the overall status of the batch | Success, Failure, Partial Success |
batchId |
| string | Every request will generate a batchId (GUID) |
|
successDetails |
| List of Objects | This object holds the list of contactCode which are passed in the payload got successfully processed. |
|
errorDetails |
| List of Objects |
|
|
Succes/Error Details | ||||
Property | Required? | Data type | Description | Validations / Exceptions |
successDetails.key |
| String | contactCode of the every user in the payload. |
|
errorDetails.key |
| String | ContactCode of the user which got failed in the payload during processing. |
|
errorDetails,errorDetails |
| Object | Contains overall details of the errors. |
|
errorDetails.description |
| String | Concatinated error messages under the errordetails object above. |
|
errorDetails.status |
| String | Indicates the type of error during the processing. | VALIDATION_ERROR, PROCESSING_ERROR |
errorDetails.errorDetails.errorModel |
| List of Objects | List of all the error specific to the section. |
|
errorDetails.errorDetails.errorModel.key |
| String | Identifier for the section of the payload where the error or validation occurs | Contact, OrgMapping, PAS, Region, CustomAttribute, Address, User etc. |
errorDetails.errorDetails.errorModel.errors |
| List of Objects | Within the section of the payload there may be more than one errors or validation, this section hold those details. |
|
errorDetails.errorDetails.errorModel.errors.key |
| String | Type of error | Mandatory, Argument, InvalidOperation, validation are type of exceptions. |
errorDetails.errorDetails.errorModel.errors.description |
| String | Exact error message on that field |
|