Submit RFI Response
This API is used to submit responses for the RFI fetched using Get All RFI API.
URL
POST https://api-test.instarem.com:4803/api/v1/client/{clientId}/rfi/{rfiId}
Header Parameters:
Parameter | Description | Type | Required |
---|---|---|---|
authorization | Authentication token. | String | Yes |
content-type | The Content-Type entity header is used to indicate the media type of the resource. Expected values could be multipart/form-data. | String | Yes |
Path Parameters:
Parameter | Description | Type | Required |
---|---|---|---|
clientId | This is the unique client ID generated by Nium. | String | Yes |
rfiId | This is the unique client ID generated by Nium. | String | Yes |
Example Request:
- Bash
- Javascript
- C#
curl --request post \
--url "https://api-test.instarem.com:4803/api/v1/client/{clientId}/rfi/{rfiId}" \
--header 'authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0OTgxMzQ4OTQsImRhdGEiOnsic3ViIjoiNTk0MjNmMzZjZWEyMTQ2OTI2ODczOWE1IiwiY2xpZW50IjoiNTk0MjNmMzZjZWEyMTQ2OTI2ODczOWExIn0sImlhdCI6MTQ5ODA0ODQ5NH0.pevwSDpk-JDNtVIpqFu_m0Xu1UnDVumrAYStcrxf8sM' \
--header 'content-type: application/json' \
--form "comments=Attached invoice copy" \
--form "file="
var data = new FormData()
data.append("comments", "Attached invoice copy")
data.append("file", "")
var xhr = new XMLHttpRequest();
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("post", "https://api-test.instarem.com:4803/api/v1/client/{clientId}/rfi/{rfiId}")
xhr.setRequestHeader("authorization", "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0OTgxMzQ4OTQsImRhdGEiOnsic3ViIjoiNTk0MjNmMzZjZWEyMTQ2OTI2ODczOWE1IiwiY2xpZW50IjoiNTk0MjNmMzZjZWEyMTQ2OTI2ODczOWExIn0sImlhdCI6MTQ5ODA0ODQ5NH0.pevwSDpk-JDNtVIpqFu_m0Xu1UnDVumrAYStcrxf8sM");
xhr.setRequestHeader("content-type", "application/json");
xhr.send(data);
var client = new RestClient("https://api-test.instarem.com:4803/api/v1/client/{clientId}/rfi/{rfiId}");
var request = new RestRequest(Method.POST);
request.AddHeader("authorization", "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0OTgxMzQ4OTQsImRhdGEiOnsic3ViIjoiNTk0MjNmMzZjZWEyMTQ2OTI2ODczOWE1IiwiY2xpZW50IjoiNTk0MjNmMzZjZWEyMTQ2OTI2ODczOWExIn0sImlhdCI6MTQ5ODA0ODQ5NH0.pevwSDpk-JDNtVIpqFu_m0Xu1UnDVumrAYStcrxf8sM");
request.AddHeader("content-type", "application/json");
request.AddParameter("comments", "Attached invoice copy")
request.AddFile("file", "")
IRestResponse response = client.Execute(request);
Body Parameters:
Parameter | Description | Type | Required |
---|---|---|---|
comments | The comments against rfi. | String | Yes |
file | These documents could be invoice copy, PO copy, shipment notice copy for the Payers reference. | File | Yes |
Response:
{
"rfiId": "03bd58a0-f726-11ea-ab6c-414e561364fe",
"requesterComment": "Requester comment against RFI",
"responderComment": "Provided Invoice copy",
"rfiStatus": "RESPONDED",
"documentTypeId": "03bd58a0-f726-11ea-ab6c-414e312364fd",
"documentType": "INVOICE_COPY"
}
Parameter | Description | Type |
---|---|---|
rfiId | Unique rfi id generated by Nium. | String |
requesterComment | Requester comments against RFI. | String |
responderComment | Responder comment against RFI. | String |
rfiStatus | This field defines the Rfi Status and the value for this could be RAISED or RESPONDED. | String |
documentTypeId | Unique document id of receive generated by Nium. | String |
documentType | This field defines the type of document and the value for this could be INVOICE_COPY or ADVANCED_SHIPMENT_NOTICE or PURCHASE_ORDER_COPY. | String |