New Vendor Request Get All Comments
Syntax
GET new-vendor-requests/{id}/comments/
Returns a JSON object that contains all comments associated with a New Vendor Request identified by {id}. The user performing this request has to be authorized to View New Vendor Requests.
Example:
GET /api/new-vendor-requests/16493/comments/
This sample call will return all comments that are associated with New Vendor Registration 16493
Request Parameters
| Parameter | Type | Description | Example |
|---|---|---|---|
| page | Number | A page number within the paginated result set. | page=2 will return the second page. |
| per_page | Number | Number of results to return per page. Default value is 10. | per_page=20 will return twenty comments per page. |
Success Codes
| HTTP Status Code | Exception | Description |
|---|---|---|
| 200 | Success | It will return all comments that that are associated with a particular NVR. |
Sample Response
Returns a JSON object with one page of results. Example:
{
"count": 4,
"next": null,
"previous": null,
"results": [ ...
]
}
where:
| Key | Type | Sample Value | Description |
|---|---|---|---|
| count | Number | 4 | How many tags were retrieved. |
| next | String | https://paymentworks.com/api/new-vendor-requests/16493/comments/?page=2 | The URL to the next page or null if the number of result is less than per_page (default is 10). |
| previous | String | https://paymentworks.com/api/new-vendor-requests/16493/comments/?page=1 | The URL to the previous page or null if this is the first page. |
| results | Array of JSON objects | [ { Comment 1 }, { Comment 2 }, { Comment 3} … ] | An array of JSON objects where each object is one comment. This array is always at most one page long. |
Each comment is a JSON object. Example:
{
"id": 19066,
"created": "2023-02-17T16:13:59.005666-05:00",
"modified": "2023-02-17T16:13:59.005666-05:00",
"submitted_by_email": "goran.stojanov+wolcott@paymentworks.com",
"message": "This comment will be added to the NVR",
"submitted_by_user": "Goran Stojanov",
"nvr": 16493
}
where:
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_get_comments",
"request": {
"auth": {
"type": "apikey",
"apikey": {
"value": "Token 500aXXXXXXXXXXXXXXXb1cf",
"key": "Authorization"
}
},
"method": "GET",
"header": [],
"url": "https://sandbox.paymentworks.com/api/new-vendor-requests/16493/comments/"
},
"response": []
},
Sample PostMan call:
cURL
Python
