GetBulkResult (GET) | GEP TECH DOCUMENTATION

Download

Overview

This GET API can be used to retrieve Bulk Result details in GEP SMART to post them into ERP.

URL Format: https://<Instance>/SmartBulkInterfaceAPI/api/BulkResult/GetBulkResult

Request

https://<Instance>/SmartBulkInterfaceAPI/api/BulkResult/GetBulkResult?BatchId=1a449236-5de4-4f3a-a161-5d0691a7dedd

Response

Failure

[
  {
    "status": "Failure",
    "errorDetails": [
      {
        "key": "9a449236-5de4-4f3a-a161-5d0691a7dedd|85f45437-42da-45af-9660-19670f3cb8c0",
        "description": "Invalid LOB Entity Type. Invalid Entity Type"
      },
      {
        "key": "01364624-eaf3-43d0-b46e-57be765eac8d|560f778e-fe38-4cbc-88cf-46bffdc4c3d7",
        "description": "Invalid LOB Entity Type. Invalid Entity Type"
      }
    ],
    "successDetails": []
  }
]

Success

{
  "status": "Success",
  "errorDetails": [],
  "successDetails": [
    {
      "key": "9a449236-5de4-4f3a-a161-5d0691a7dedd|85f45437-42da-45af-9660-19670f3cb8c0"
    },
    {
      "key": "01364624-eaf3-43d0-b46e-57be765eac8d|560f778e-fe38-4cbc-88cf-46bffdc4c3d7"
    }
  ]
}

Partial Success

{
  "status": "PartialSuccess",
  "errorDetails": [
    {
      "key": "9a449236-5de4-4f3a-a161-5d0691a7dedd|85f45437-42da-45af-9660-19670f3cb8c0",
      "description": "Invalid LOB Entity Type. Invalid Entity Type"
    },
    {
      "key": "01364624-eaf3-43d0-b46e-57be765eac8d|560f778e-fe38-4cbc-88cf-46bffdc4c3d7",
      "description": "Invalid LOB Entity Type. Invalid Entity Type"
    }
  ],
  "successDetails": [
    {
      "key": "9a449236-5de4-4f3a-a161-5d0691a7dedd|85f45437-42da-45af-9660-19670f3cb8c0"
    },
    {
      "key": "01364624-eaf3-43d0-b46e-57be765eac8d|560f778e-fe38-4cbc-88cf-46bffdc4c3d7"
    }
  ]
}

Examples

Success Scenario 1 - Request

Request below describes that this contains only the valid BatchID, which exist in the database: (200 – OK)

https://api-smartdev.gep.com/SmartBulkInterfaceAPI/api/BulkResult/GetBulkResult?batchId=7403b34c6351473b

Success Scenario 1 - Response

{
  "status": "Success",
  "errorDetails": [],
  "successDetails": [
    {
      "key": "d8256dca-8f94-4ee4-8743-85656460bfd3|cbb69f40-5188-4f34-b316-54bb88cf14a6"
    },
    {
      "key": "b517ac19-013d-480a-859a-02c172565e51|dca6e46f-c083-4d5c-a338-0f1ea3e0d288"
    }
  ]
}

Success Scenario 2 - Request

Request below describes that this contains only the valid BatchID, which exist in the database and request is not processed: (202 – Accepted)

https://api-smartdev.gep.com/SmartBulkInterfaceAPI/api/BulkResult/GetBulkResult?batchId= 132d08bbe5694

Success Scenario 2- Response

{
  "status": "Processing in progress",
  "errorDetails": [],
  "successDetails": []
}

Error Scenario 1 - Request

Request below describes that this contains only the valid BatchID, which does not exist in database: (400 – Bad Request)

https://api-smartdev.gep.com/SmartBulkInterfaceAPI/api/BulkResult/GetBulkResult?batchId= ae3226f310f6460

Error Scenario 1 - Response

The provided BatchID is not available in system.

Data Elements

	Get Bulk Result
S.No.	Property	Required?	Data type	Description	Validations/Exceptions
1	Status		String
2	ErrorDetails		List of ErrorDetail object
3	SuccessDetails		List of SuccessDetail object

	ErrorDetails
S.No.	Property	Required?	Data type	Description	Validations/Exceptions
2.1	Key		String
2.2	Description		String

	SuccessDetails
S.No.	Property	Required?	Data type	Description	Validations/Exceptions
3.1	Key		String