Get All RFI

This API will help you to fetch the details associated with the RFI on the basis of transaction Id for each clientId.

Definition

URL

GET https://api-test.instarem.com:4803/api/v1/client/{clientId}/rfi/transaction/{transactionId}

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 application/json or multipart/form-data.	String	Yes

Path Parameters:

Parameter	Description	Type	Required
clientId	This is the unique client ID generated by Nium.	String	Yes
transactionId	This is the unique transaction ID generated by Nium.	String	Yes

Example Request:

Bash

curl --request get \\
--url "https://api-test.instarem.com:4803/api/v1/client/{clientId}/rfi/transaction/{transactionId}" \\
--header 'authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0OTgxMzQ4OTQsImRhdGEiOnsic3ViIjoiNTk0MjNmMzZjZWEyMTQ2OTI2ODczOWE1IiwiY2xpZW50IjoiNTk0MjNmMzZjZWEyMTQ2OTI2ODczOWExIn0sImlhdCI6MTQ5ODA0ODQ5NH0.pevwSDpk-JDNtVIpqFu_m0Xu1UnDVumrAYStcrxf8sM' \\
--header 'content-type: application/json'

Javascript

var xhr = new XMLHttpRequest();
xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});
xhr.open("get", "https://api-test.instarem.com:4803/api/v1/client/{clientId}/rfi/transaction/{transactionId}");
xhr.setRequestHeader("authorization", "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0OTgxMzQ4OTQsImRhdGEiOnsic3ViIjoiNTk0MjNmMzZjZWEyMTQ2OTI2ODczOWE1IiwiY2xpZW50IjoiNTk0MjNmMzZjZWEyMTQ2OTI2ODczOWExIn0sImlhdCI6MTQ5ODA0ODQ5NH0.pevwSDpk-JDNtVIpqFu_m0Xu1UnDVumrAYStcrxf8sM");
xhr.setRequestHeader("content-type", "application/json");
xhr.send();

C#

var client = new RestClient("https://api-test.instarem.com:4803/api/v1/client/{clientId}/rfi/transaction/{transactionId}");
var request = new RestRequest(Method.GET);
request.AddHeader("authorization", "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE0OTgxMzQ4OTQsImRhdGEiOnsic3ViIjoiNTk0MjNmMzZjZWEyMTQ2OTI2ODczOWE1IiwiY2xpZW50IjoiNTk0MjNmMzZjZWEyMTQ2OTI2ODczOWExIn0sImlhdCI6MTQ5ODA0ODQ5NH0.pevwSDpk-JDNtVIpqFu_m0Xu1UnDVumrAYStcrxf8sM");
request.AddHeader("content-type", "application/json");
IRestResponse response = client.Execute(request);

Response (200):

[
    {
        "rfiId": "03bd58a0-f726-11ea-ab6c-414e561364fe",
        "requesterComment": "Need invoice copy",
        "responderComment": "",
        "rfiStatus": "RAISED",
        "documentTypeId": "03bd58a0-f726-11ea-ab6c-414e312364fd",
        "documentType": "INVOICE_COPY"
    },
    {
        "rfiId": "21cd88a0-f896-11ea-ab6c-214e532343ef",
        "requesterComment": "Need purchase order copy",
        "responderComment": "",
        "rfiStatus": "RAISED",
        "documentTypeId": "32bd78a0-s981-99ea-ab6c-324e312387sd",
        "documentType": "PURCHASE_ORDER_COPY"
    },
    {
        "rfiId": "192fae14-e891-4468-bb7a-cbb9dbb8d78b",
        "requesterComment": "invoice copy",
        "responderComment": "RFI Responded",
        "rfiStatus": "RESPONDED",
        "documentTypeId": "e0758b6e-80aa-4a73-a481-ae1f176797f0",
        "documentType": "ADVANCED_SHIPMENT_NOTICE"
    }
]

Response Parameters:

Parameter	Description	Type
rfiId	Unique rfi id generated by Nium.	String
requesterComment	Requester comment 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 - ADVANCED_SHIPMENT_NOTICE - PURCHASE_ORDER_COPY	String