TravelCaster API - ReportNIR

Back to Reports home.

---

The ReportNIR service provides all the reservations of a full day or a specific time window. As it is based on AIR version 207, the customers who already consume this format, will be able to perform an easy and fast implementation.

Request

XML

EndPoint: https://endpoint/reports/GetNIR.ashx [POST]

Headers: ApiKey

Parameter: query ([Request])

Returns: Zip field

Structure of the request document

Request
  |
  |_ FromDate (string - Two format alternatives)
              (ISO 8601 yyyy-MM-ddTHH:mm:ss.fff format - TimeZone: GMT)
              (ISO 8601 yyyy-MM-ddTHH:mm:ss.fffzzzzz format - Specific TimeZone, Eg: -03:00)
  |_ ToDate(string - Two format alternatives)
            (ISO 8601 yyyy-MM-ddTHH:mm:ss.fff format - TimeZone: GMT)
            (ISO 8601 yyyy-MM-ddTHH:mm:ss.fffzzzzz format - Specific TimeZone, Eg: -03:00)

Product notes

• Content:
  • NDC.
  • Direct Connection (LCC and IATA carriers).
  • GDS.
• Functionality:
  • Issue: Yes.
  • Void: No.
  • Exchange: No.

Request notes

• ApiKey: It contains the Agency PCCs setting, allowing us to provide as many configurations under ApiKeys as the customer needs. A customer could request only one ApiKey for all the PCCs, or one ApiKey for traditional (GDS) content and another one for non-traditional content, or several ApiKeys defined by group of PCCs.
• Minimum time between requests: 20 minutes.
• Time range: Max of 26hs.

Recommended implementation:

• The NIR file for each ticket is generated each 20 minutes. So, we do not recommend to run instantaneous requests.
• Assuming that it is 10:40hs and we perform a req every 20mins, execute the following request:

  <Request>
    <FromDate>2025-01-15T10:00:00.000-03:00</FromDate>
    <ToDate>2025-01-15T10:19:59.999-03:00</ToDate>
  </Request>
  

• Then, at the next req at 11:00hs, execute the following request:

  <Request>
    <FromDate>2025-01-15T10:20:00.000-03:00</FromDate>
    <ToDate>2025-01-15T10:39:59.999-03:00</ToDate>
  </Request>
  

• Applying this logic, you will be able to obtain all the day reservations, avoiding duplicates.
• As shown in the example requests, the date can include the GMT (in this case -03:00), to simplify the implementation logic.

Response notes

• Success response:
  • The service returns a zip file which contains the reservations that applies with the request.
  • File format: Format based on AIR version 207.
  • File name format: The file name begins with "NIR_", followed by date time information. E.g. "NIR_2024-01-29T1030".
• Error response: In case of an error, the service will return a "response.txt" file which contains the error description.
• Ticketless carriers:
  • These carries do not provide ticket number.
  • As some customers need information into the "T" file, we introduce an own infomatin that begins "000". E.g. "T-K000-0000050494".
  • In these cases, the "A" file contains the carrier information. E.g. "A-FLYBONDI;FO ---0".
• Remark information:
  • Wings has a set of fields (optional or mandatory) that could be requested to the agent before closing the reservation.
  • NIR format: RM ST-123456.
  • These are some common remarks:
    • RMK-SL → Requested by / agent.
    • RMK-ST → Cost center.
    • RMK-NO → Order number.
    • RMK-RF → File.

Change log

Date	Affects versions	Change detail
2024-01-29	1.0	Initial version.

---

Back to Reports home.