New Vendor Request Add Comment
Syntax
POST new-vendor-requests/{id}/comments/
body = {"message": "This comment will be added to the NVR"}
To add a comment to a New Vendor Request identified by {id} add a body to the request that will have one key pair: "message": "Comment to add." .
Example:
POST /api/new-vendor-requests/20100/comments/
body = {"message": "This comment will be added to the NVR"}
Request Parameters
There are no request parameters for this API.
Success Codes
| HTTP Status Code | Exception | Description |
|---|---|---|
| 201 | Created | The comment is added to the New Vendor Request. |
Sample Response
Returns the number of objects added, in this case one. Example:
Error Codes
| HTTP Status Code | Exception | Description |
|---|---|---|
| 400 | Bad Request | The request could not be understood by the server due to incorrect syntax. |
| 401 | Unauthenticated | The request requires user authentication information. Your API token is missing or invalid. |
| 403 | Forbidden | Unauthorized request. The client does not have access rights to the content. Unlike 401, the client’s identity is known to the server. |
| 404 | Not Found | You are trying to retrieve comments for a non existing NVR. |
| 500
503 | Service Unavailable | The request has failed due to a temporary failure of the server. You can try this request at a later time. |
Calling the API
Postman
Call Syntax:
{
"name": "NVR_AddComment",
"request": {
"auth": {
"type": "apikey",
"apikey": {
"value": "Token 500a323af3f570332231c3e89cfa63a4c176b1cf",
"key": "Authorization"
}
},
"method": "POST",
"header": [],
"body": {
"mode": "raw",
"raw": "{\n \"message\": \"This is message 1\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": "https://sandbox.paymentworks.com/api/new-vendor-requests/19030/comments/"
},
"response": []
},
Sample PostMan call:
cURL
Python
