UpdateRequisitionLineStatus (PUT)

  • Overview
  • Request
  • Response
  • Examples
  • Data Elements
Overview

This API allows us to update the requisition line level status in GEP SMART.

URL Format: https://<Instance>/SmartInterfaceAPI/api/Requisition/UpdateRequisitionLineStatus

Request 
[
  {
    "requisitionNumber": "string",
    "requsitionId": 0,
    "stockReservationStatus": "string",
    "isUpdateForAll": true,
    "lineItems": [
      {
        "lineNumber": 0,
        "lineStatus": "string",
        "reservationNumber": "string"
      }
    ],
    "stockReservationNumber": "string"
  }
]

 

Response 
{
   "data": {},
   "statusCode": "String",
   "errorDetails": [
      {
         "key": "string",
         "errors": [
            {
               "errorCode": "string",
               "errorDescription": "string"
            }
         ]
      }
   ],
   "successDetails": [
      {
         "key": "String"
      }
   ]
}

 

Examples

Success Scenario - Request 

[
    {
        "RequisitionNumber": "REQ-2020.001420",
        "IsUpdateForAll": false,
        "LineItems": [
            {
                "LineNumber": 1,
                "LineStatus": "StockReserved"
            },
            {
                "LineNumber": 2,
                "LineStatus": "StockReserved"
            }
        ]
    }
]

Success Scenario - Response 

{
	"data": null,
	"statusCode": "400",
	"errorDetails": [],
	"successDetails": [
		{
			"key": " REQ-2020.001420"
		}
	]
}

Error Scenario - Request 

[
    {
        "RequisitionNumber": "REQ-2020.001420",
        "IsUpdateForAll": false,
        "LineItems": [
            {
                "LineNumber": 1,
                "LineStatus": "StockReserved"
            },
            {
                "LineNumber": 2,
                "LineStatus": "StockReserved"
            },
            {
                "LineNumber": 3,
                "LineStatus": "StockReserved"
            },
            {
                "LineNumber": 4,
                "LineStatus": "StockReservedFail"
            }
        ]
    }
]

Error Scenario - Response 

{
    "data": null,
    "statusCode": "400",
    "errorDetails": [
        {
            "key": "REQ-2020.001420",
            "errors": [
                {
                    "errorCode": "DataException",
                    "errorDescription": "StockReservedFail is Invalid Stock Status at Line Level 4"
                },
                {
                    "errorCode": "DataException",
                    "errorDescription": "Requisition line number 2 is invalid"
                },
                {
                    "errorCode": "DataException",
                    "errorDescription": "Requisition line number 3 is invalid"
                },
                {
                    "errorCode": "DataException",
                    "errorDescription": "Requisition line number 4 is invalid"
                }
            ]
        }
    ],
    "successDetails": []
}

 

Data Elements

Model

Property

Required?

Data type

Description

Validations/Exceptions

RequisitionNumber

Yes

String

Key of the entity

Requisition Number is mandatory
Invalid Requisition Number

RequisitionId

No

Int

Description of the entity

 

StockReservationStatus

No

String

 

 

IsUpdateForAll

No

Boolean

Name of the entity

  

LineItems

No

String

Line-of-business

  

UpdateProcessedRequisitionStatus

Property

Required?

Data type

Description

Validations/Exceptions

Model

Yes

List of Requisition Line Detail object

 

 

LineItems

Property

Required?

Data type

Description

Validations/Exceptions

LineNumber 

Yes

Long

 

•    Line Number is mandatory
•    Invalid Line Number
 

LineStatus

  

String

  

Invalid Stock Status at line level

ReservationNumber

  

String