OTA Error Response

• 1. Introduction
  • 1.1 Purpose of this Document
  • 1.2 Error Response Format
    • Error Response Structure
    • Response fields and meaning
    • HTTP Status Codes
• 2. Type of Error
  • 2.1 Error Content
• 3. Error Code
  • 3.1 GO7 Internal OTA Error Code
  • 3.2 External OTA Error Code

1. Introduction

1.1 Purpose of this Document

To establish a standardized way to handle and respond to errors during API communication between GO7 and OTA partners. This enables better troubleshooting, clear messaging, and smooth end-user experiences.

1.2 Error Response Format

All API responses containing errors will be returned with the following JSON structure and appropriate HTTP status codes:

Error Response Structure

{
  "status": HTTP Status Codes,
  "code": "ERR_CODE",
  "title": "Human-readable description of the error",
  "detail": "Optional technical details for debugging (if any)",
  "correlationId": "e76b44e8-91e2-4fba-88d8-562a6ed7d755"
}

Note: Other elements not listed in the structure are optional and are intended for internal use by GO7.

Response fields and meaning

HTTP Status Codes

2. Type of Error

There are 2 types of error included in the content which are ‘External error’ and ‘Internal error’.

External error - any errors return from HHR system or any 3rd party  
Internal error - any errors occurs in GO7 microservice

To ensure clarity on error origins, any failure caused by an external service is explicitly reported as the primary error in our response. While doing so, our system reformats the error information received from the external service to match our standard response structure; this changes only the format, ensuring the original error content is preserved. This overall design allows consumers of our service to immediately identify when a reported issue stems from an external dependency, while still receiving the necessary details in a consistent format.

2.1 Error Content

Error responses contain specific details for investigating issues. The main reason (root cause) are shown in the first level which are status, error, code, title, and correlationId that required by the support team for further investigation. Information contained within the cause field should generally be disregarded, as it typically presents low-level technical details intended for developers.

  {
    "status": 422,
    "error": "Unprocessable Entity",
    "code": "878",
    "title": "Missing/incorrect document type",
    "detail": "No identType found for document type code CC",
    "correlationId": "88f48120-952c-4ebe-b889-809c129932ea",
    "service": "ota-service",
    "instance": "/v2015b/OTA",
    "tenant": "test-skywork-dev",
    "timestamp": "2025-04-16T02:48:11.178912262Z",
    "cause": {
      "status": 422,
      "title": "Missing/incorrect document type",
      "detail": "Issuing tickets for 76ZWU2 failed: 422 : \"{\"type\":null,\"status\":422,\"code\":\"878\",\"title\":\"Missing/incorrect document type\",\"detail\":\"No identType found for document type code CC\",\"correlationId\":\"79f48120-952c-4ebe-b889-809c129932ee\",\"service\":\"hhr-proxy\",\"instance\":\"/tickets/A4561192D\",\"tenant\":\"mservice\",\"timestamp\":\"2025-04-17T02:48:11.127672994Z\",\"cause\":null}\"",
      "correlationId": "88f48120-952c-4ebe-b889-809c129932ea",
      "service": "ticket-service",
      "tenant": "mservice",
      "timestamp": "2025-04-16T02:48:11.164445981Z",
      "cause": {
        "status": 422,
        "code": "878",
        "title": "Missing/incorrect document type",
        "detail": "No identType found for document type code CC",
        "correlationId": "88f48120-952c-4ebe-b889-809c129932ea",
        "service": "hhr-proxy",
        "tenant": "mservice",
        "timestamp": "2025-04-16T02:48:11.164401079Z"
      }
    }
  }
  

3. Error Code

3.1 GO7 Internal OTA Error Code

3.2 External OTA Error Code