Update Gatepass

This REST API is used to modify gatepass details in Uniware.

Tip

It is recommended to check out Notes for the reader. You might find this helpful as it contains Guidelines for using API references and Terminologies used here.

Basic Information

NAME	DETAILS
Endpoint:	/services/rest/v1/purchase/gatepass/edit
Request Type:	POST
Level:	Facility
Scheme:	HTTPS
Header (Content-Type):	application/json
Header (Authorization):	bearer {access-token}, Eg.: bearer b30f3aea-7978-49bb-9ea7-33eddfc80afa
Header (Facility):	facility code as in Uniware (refer FAQs)

Request Payload

{
   "gatePassCode": "string",
   "wsGatePass": {
      "code": "string",
      "purpose": "string",
      "transferAmount": 0,
      "referenceNumber": "string",
      "customFieldValues": [
         {
            "name": "string",
            "value": "string"
         }
      ]
   }
}

Request Payload Details

LEVEL	PARAMETER	TYPE	DESCRIPTION	MANDATORY	NOTES
1	gatePassCode	string	Gatepass code	Yes
2	wsGatePass	object	Gatepass details	Yes
2.1	code	string	Code	No
2.2	purpose	string	Purpose	No	Max. chars: 500
2.3	transferAmount	number	Transfer amount	No
2.4	referenceNumber	string	Reference no.	No	Max. chars: 45
2.5	customFieldValues	list	Custom field details	No
2.5.1	name	string	Custom field name	Yes
2.5.2	value	string	Custom field value	No

Response Payload

{
   "successful": true,
   "message": "string",
   "errors": [
      {
         "code": 0,
         "fieldName": "string",
         "description": "string",
         "message": "string",
         "errorParams": {
            "additionalProp1": {},
            "additionalProp2": {},
            "additionalProp3": {}
         }
      }
   ],
   "warnings": [
      {
         "code": 0,
         "message": "string",
         "description": "string"
      }
   ],
   "gatePassCode": "string"
}

Response Payload Details

LEVEL	PARAMETER	TYPE	DESCRIPTION	NOTES
1	successful	true	Request success status	-
2	message	string	Response message	-
3	errors	list	List of errors (if any)	-
3.1	code	number	Error code	-
3.2	fieldName	string	Field with error	-
3.3	description	string	Error description	-
3.4	message	string	Error message	-
3.5	errorParams	object	Parameters with error	-
3.5.1	additionalProp1	object	Parameter 1 with error	-
3.5.2	additionalProp2	object	Parameter 2 with error	-
3.5.3	additionalProp3	object	Parameter 3 with error	-
4	warnings	list	List of warnings (if any)	-
4.1	code	number	Warning code	-
4.2	message	string	Warning message	-
4.3	description	string	Warning description	-
5	gatePassCode	string	Gatepass code	-

Error Codes

Refer Response Codes section to know about specific errors codes.