RequisitionInboundStatus (POST)

Overview

 This POST API can be used to retrieve status and error details for posted inbound. 

URL Format: https:// <Instance>//leo-requisition-inbound/api/v2/ReqInbound/GetRequisitionInboundStatus

Request
 {"sourceSystemValue": "oct_10_29_1"}
 
 OR
 
  {"documentId": "80279222-C940-4FB6-9798-E0E420DCAD1B"}
Response
{
   "returnValue": {
      "status": "Failure",
      "progressSummary": "Batch Status - ProcessCompletedWithFailure",
      "batchId": "25fb9ac2-887e-4a51-a18a-9f5aa1a17742",
      "totalRecords": 1,
      "successCount": 0,
      "errorCount": 1,
      "errorDetails": {
         "headers": [],
         "lines": {
            "1": [
               "Either the requester's access is limited to the catalog or the  supplier item number entered does not exist.",
               "Please enter a valid Supplier ClientContactCode to proceed"
            ]
         },
         "accounts": {}
      },
      "successDetails": [],
      "docStatus": "Draft",
      "docNumber": "PR154273",
      "sourceSystemValue": "oct_10_29_1",
      "documentId": "80279222-C940-4FB6-9798-E0E420DCAD1B",
      "documentUrl": "https://nexxeuat.gep.com/UATBOFA3/v3/#/req_requisition_detail/80279222-C940-4FB6-9798-E0E420DCAD1B",
      "poDetails": []
   },
   "isSuccess": true,
   "errors": null,
   "exception": null,
   "errorMessage": null,
   "errorCode": null,
   "correlationId": "0HN7G62R8K1AP:00000001"
}

OR

{
   "returnValue": null,
   "isSuccess": false,
   "errors": null,
   "exception": null,
   "errorMessage": "Problem while processing requisition please try after some time.",
   "errorCode": null,
   "correlationId": "0HN7G63DHOHVP:00000001"
}
Data Elements

Request Payload

Property 

Required? 

Data type 

Description 

Validations / Exceptions 

sourceSystemValue

 yes

String  

Unique Identifier to find requisition inbound file details

 

documentId

 

String  

Unique Identifier for requisition document

 

 

Response Success or Failure 

Property 

Required? 

Data type 

Description 

Validations / Exceptions 

returnValue.status

 

string

 

 

returnValue.progressSummary

 

string

 

 

returnValue.batchId

 

string

 

 

returnValue.totalRecords

 

number

 

 

returnValue.successCount

 

number

 

 

returnValue.errorCount

 

number

 

 

returnValue.errorDetails.headers

 

 

 

 

returnValue.errorDetails.lines.1

 

Array

 

 

returnValue.errorDetails.lines.1[0]

 

string

 

 

returnValue.errorDetails.lines.1[1]

 

string

 

 

returnValue.successDetails

 

Array

 

 

returnValue.docStatus

 

string

 

 

returnValue.docNumber

 

string

 

 

returnValue.sourceSystemValue

 

 

 

 

returnValue.documentId

 

string

 

 

returnValue.documentUrl

 

string

 

 

returnValue.poDetails

 

Array

 

 

isSuccess

 

boolean

 

 

errors

 

object

 

 

exception

 

object

 

 

errorMessage

 

 

 

 

errorCode

 

object

 

 

correlationId

 

string