Goelett

Authentication

Authenticate user in Goelett

Cart

Views the cart.

Gets the cart.

Dictionary

Gets all currencies supported by maya sbt

Gets all countries supported by maya sbt

Gets all company custom fields defined in traveller context in maya sbt

Gets all company job positions defined in the maya sbt

Gets all loyalty programs supported in maya sbt

Gets all railway stations supported in maya sbt

Gets company structure

Healthcheck

Basic ping

Search

Initializes the search rail.

Initializes the search air.

Initializes the search car.

Initializes the search hotel.

Travellers

Create travellers bulk

Update travellers bulk

[Obsolete] Creates travellers' profiles in maya sbt

[Obsolete] Post update of users profiles

[Obsolete] Patch update of travellers profiles

Deletes travellers' profiles in maya sbt

Gets travellers' profiles in maya sbt

Gets travellers' list in maya sbt

Get All travellers

Updates travellers' pools in maya sbt

Workflowapproval

Approves trip.

Rejects trip.

MAYA SBT API

Goelett SBT API 1.1

Production

The Authentication section of the Goelett SBT API allows you to securely authenticate and access resources within the API. By making requests to the authentication endpoint, you can obtain an access token that will grant you authorized access to the API.Use this endpoint to authenticate your application and generate an access token. Once you have obtained an access token, you can include it in the header of subsequent API requests to authenticate and authorize access to protected resources.Authentication is a crucial step in integrating with the Goelett SBT API. It ensures that only authorized users and applications can interact with the API and perform actions on behalf of authenticated users.To authenticate, simply make a POST request to the authentication endpoint with your application credentials. The endpoint will validate your credentials and return an access token if the authentication is successful.Keep in mind that the access token has an expiration time. After the token expires, you will need to re-authenticate and obtain a new access token.It is important to securely store and handle the access token. Treat it as a sensitive piece of information and avoid exposing it to unauthorized individuals or storing it in an insecure manner.By successfully authenticating and obtaining an access token, you can seamlessly integrate with the Goelett SBT API and access its various resources, enabling you to build powerful applications and leverage the functionality provided by the API.

The Authentication section of the Goelett SBT API allows you to securely authenticate and access resources within the API. By making requests to the authentication endpoint, you can obtain an access token that will grant you authorized access to the API.

Use this endpoint to authenticate your application and generate an access token. Once you have obtained an access token, you can include it in the header of subsequent API requests to authenticate and authorize access to protected resources.

Authentication is a crucial step in integrating with the Goelett SBT API. It ensures that only authorized users and applications can interact with the API and perform actions on behalf of authenticated users.

To authenticate, simply make a POST request to the authentication endpoint with your application credentials. The endpoint will validate your credentials and return an access token if the authentication is successful.

Keep in mind that the access token has an expiration time. After the token expires, you will need to re-authenticate and obtain a new access token.

It is important to securely store and handle the access token. Treat it as a sensitive piece of information and avoid exposing it to unauthorized individuals or storing it in an insecure manner.

By successfully authenticating and obtaining an access token, you can seamlessly integrate with the Goelett SBT API and access its various resources, enabling you to build powerful applications and leverage the functionality provided by the API.

The Cart API section provides functionality for managing shopping carts in the Goelett SBT system. With this API, you can retrieve information about a specific cart, including its contents and total price. You can also create new carts, update existing ones, and delete them when they are no longer needed. This API is essential for any application or system that requires shopping cart functionality, such as e-commerce platforms or order management systems. Additionally, the Cart API supports pagination, allowing you to retrieve carts in batches rather than all at once, which can be useful for optimizing performance.

The Cart API section provides functionality for managing shopping carts in the Goelett SBT system. With this API, you can retrieve information about a specific cart, including its contents and total price. You can also create new carts, update existing ones, and delete them when they are no longer needed. This API is essential for any application or system that requires shopping cart functionality, such as e-commerce platforms or order management systems. Additionally, the Cart API supports pagination, allowing you to retrieve carts in batches rather than all at once, which can be useful for optimizing performance.

The GET Dictionary API section provides access to the Goelett SBT API 1.1 dictionary endpoint. This endpoint allows you to retrieve information from the dictionary database.With this API, you can retrieve definitions, synonyms, antonyms, and other relevant information for words or phrases. It is a valuable resource for content creators, language learners, and anyone who needs to work with textual data.The GET Dictionary API supports various useful features such as searching for exact matches, fuzzy search, and wildcard search. These features enhance the flexibility and accuracy of your searches, ensuring you can find the information you need.Additionally, this API supports pagination, allowing you to retrieve large result sets in manageable chunks. This is particularly helpful when working with extensive dictionaries or when you need to limit the number of results returned.To use the GET Dictionary API, simply make a GET request to the designated endpoint. You can specify search parameters to filter the results based on your needs. The response will contain the requested information in a structured format, making it easy to parse and integrate into your application.Whether you are a developer looking to integrate word-related functionality into your application or a non-technical user in need of language resources, the GET Dictionary API section provides a straightforward and intuitive way to access and leverage the Goelett SBT API 1.1 dictionary endpoint.

The GET Dictionary API section provides access to the Goelett SBT API 1.1 dictionary endpoint. This endpoint allows you to retrieve information from the dictionary database.

With this API, you can retrieve definitions, synonyms, antonyms, and other relevant information for words or phrases. It is a valuable resource for content creators, language learners, and anyone who needs to work with textual data.

The GET Dictionary API supports various useful features such as searching for exact matches, fuzzy search, and wildcard search. These features enhance the flexibility and accuracy of your searches, ensuring you can find the information you need.

Additionally, this API supports pagination, allowing you to retrieve large result sets in manageable chunks. This is particularly helpful when working with extensive dictionaries or when you need to limit the number of results returned.

To use the GET Dictionary API, simply make a GET request to the designated endpoint. You can specify search parameters to filter the results based on your needs. The response will contain the requested information in a structured format, making it easy to parse and integrate into your application.

Whether you are a developer looking to integrate word-related functionality into your application or a non-technical user in need of language resources, the GET Dictionary API section provides a straightforward and intuitive way to access and leverage the Goelett SBT API 1.1 dictionary endpoint.

This API section provides the functionality to retrieve a list of all currencies supported by the Maya SBT system. The &apos;get /api/dictionary/currencies&apos; endpoint can be used to access this information.By making a request to this endpoint, you will receive a response containing the names and codes of the supported currencies. This information can be beneficial for various use-cases, such as displaying a dropdown list of currencies for users to select from or performing currency conversions within your application.Please note that the response will include the necessary status code (200) and specific parameters, such as the name of the currencies, response state message, and status. These parameters can be utilized to handle the response accordingly.Integrating this API section into your system will enable you to easily retrieve the list of supported currencies, facilitating smooth and accurate currency-related operations within your application.

This API section provides the functionality to retrieve a list of all currencies supported by the Maya SBT system. The 'get /api/dictionary/currencies' endpoint can be used to access this information.

By making a request to this endpoint, you will receive a response containing the names and codes of the supported currencies. This information can be beneficial for various use-cases, such as displaying a dropdown list of currencies for users to select from or performing currency conversions within your application.

Please note that the response will include the necessary status code (200) and specific parameters, such as the name of the currencies, response state message, and status. These parameters can be utilized to handle the response accordingly.

Integrating this API section into your system will enable you to easily retrieve the list of supported currencies, facilitating smooth and accurate currency-related operations within your application.

AuthToken

The Currencies parameter contains a list of all the currencies supported by Maya SBT.

Currencies

The ResponseState parameter indicates the status of the API response, such as success or failure.

ResponseState

The &quot;get /api/dictionary/countries&quot; endpoint allows you to retrieve a list of all countries supported by the Maya SBT system. This functionality is particularly useful when you need to display a list of countries for user selection or perform any operations related to country-specific data. By making a request to this endpoint, you will receive a response that includes information such as the country name and country code.Please note that the response will also include additional parameters, such as the response status and message. These parameters provide further context regarding the success or failure of the API request.Overall, the get /api/dictionary/countries endpoint simplifies the task of obtaining a comprehensive list of supported countries within the Maya SBT system.

The "get /api/dictionary/countries" endpoint allows you to retrieve a list of all countries supported by the Maya SBT system. This functionality is particularly useful when you need to display a list of countries for user selection or perform any operations related to country-specific data. By making a request to this endpoint, you will receive a response that includes information such as the country name and country code.

Please note that the response will also include additional parameters, such as the response status and message. These parameters provide further context regarding the success or failure of the API request.

Overall, the get /api/dictionary/countries endpoint simplifies the task of obtaining a comprehensive list of supported countries within the Maya SBT system.

The response parameter "Countries" contains a list of all the countries supported by the Maya SBT API. It includes information about each country, such as its name, code, and other relevant details.

Countries

The response parameter "ResponseState" indicates the state of the API response. It provides information about the overall state of the request, such as whether it was successful or encountered an error.

This API endpoint allows you to retrieve all the custom fields defined by a company in the traveler context within the Maya SBT system. The response includes various parameters such as the code, name, custom field type, possible values, regular expression, and context type for each custom field. Additionally, the response also includes a message and status indicating the state of the response. The purpose of this API is to provide a comprehensive view of the custom fields associated with a company in the traveler context.

This API endpoint allows you to retrieve all the custom fields defined by a company in the traveler context within the Maya SBT system. The response includes various parameters such as the code, name, custom field type, possible values, regular expression, and context type for each custom field. Additionally, the response also includes a message and status indicating the state of the response. The purpose of this API is to provide a comprehensive view of the custom fields associated with a company in the traveler context.

companyCode

contexType

The list of custom fields defined for the company.

CustomFields

The state or status of the response for the company custom field.

This API endpoint retrieves all job positions defined within a specific company in the Maya SBT. By making a request to this endpoint, you will receive a response that includes the name and code of each job position, as well as additional information related to the response state. The purpose of this API is to facilitate the retrieval of job position data for integration with other systems or processes.

The list of all job positions defined for the specified company.

JobPositions

The state of the response, indicating whether the request was successful or if there was an error.

This API endpoint retrieves a list of all the loyalty programs that are supported in the Maya SBT system. Loyalty programs are a type of service offered by carriers that allow customers to earn rewards or benefits based on their usage or purchases.

By calling this endpoint, you will receive a response that includes the name, code, and other relevant information for each loyalty program supported by Maya SBT. This information can be used to display the available loyalty programs to users or to integrate them into your own application.

Please note that the response will include additional parameters such as the response state and status, which provide information about the success or failure of the API call. The status code for a successful call is 200.

This API endpoint is particularly useful for developers who want to build integrations with Maya SBT and provide their users with access to loyalty programs. It can also be used by non-technical roles, such as product managers or business analysts, to gather information about the available loyalty programs and make informed decisions about their usage in the application.

Overall, the get /api/dictionary/loyaltyPrograms/{serviceType} endpoint simplifies the process of retrieving information about loyalty programs supported in Maya SBT, making API integration straightforward for both developers and non-technical roles.

serviceType

The list of loyalty programs supported in the Maya SBT.

LoyaltyPrograms

The state of the response, indicating whether it was successful or not.

This API endpoint retrieves information about railway stations that are supported in Maya SBT. The response includes the rail city name, station name, station code, and other relevant information. By using this endpoint, you can easily access a comprehensive list of railway stations for integration with your application. This API makes it straightforward to incorporate railway station data into your project, whether you are a developer or a non-technical user.

railStationType

The list of railway stations supported in Maya SBT.

RailStations

This API endpoint allows you to retrieve the company structure for a specific company using its unique company code. The response will include information such as the company name, company code, parent company code, and other details related to the company structure. 

By accessing this API, you can easily integrate the company structure data into your application or system. This can be useful for various use-cases, such as displaying the hierarchical relationship between different companies within an organization, generating reports based on the company structure, or conducting analysis on the company's organizational setup. 

It's important to note that the response will include a status code of 200, indicating a successful retrieval, along with other response state parameters. These parameters provide additional information about the status of the API request and can be used for error handling or further processing.

The code that identifies the specific company.

CompanyStructures

The state of the response, indicating whether it was successful or encountered an error.

The Healthcheck API endpoint in the Goelett SBT API 1.1 allows you to check the status and health of the SBT system. This endpoint can be used to ensure that the system is functioning properly and ready to process requests. It provides information about the overall health of the system, including its availability, performance, and any potential issues.By making a request to this endpoint, you can receive a response that indicates whether the system is healthy or not. This can be especially useful for monitoring purposes or when troubleshooting any issues that may arise during integration.The Healthcheck API endpoint does not require any specific parameters or additional input. Simply making a GET request to this endpoint will provide you with the necessary information about the system&apos;s health status.Please note that the response from this endpoint may vary depending on the current state of the system. It is important to handle different response scenarios appropriately in your application to ensure seamless integration with the Goelett SBT API 1.1.Overall, the Healthcheck API endpoint is designed to make API integration straightforward by providing a clear and concise way to check the health of the system. It allows you to quickly determine whether the SBT system is functioning properly and ready to handle requests, ensuring a smooth and reliable integration experience.

The Healthcheck API endpoint in the Goelett SBT API 1.1 allows you to check the status and health of the SBT system. This endpoint can be used to ensure that the system is functioning properly and ready to process requests. It provides information about the overall health of the system, including its availability, performance, and any potential issues.

By making a request to this endpoint, you can receive a response that indicates whether the system is healthy or not. This can be especially useful for monitoring purposes or when troubleshooting any issues that may arise during integration.

The Healthcheck API endpoint does not require any specific parameters or additional input. Simply making a GET request to this endpoint will provide you with the necessary information about the system's health status.

Please note that the response from this endpoint may vary depending on the current state of the system. It is important to handle different response scenarios appropriately in your application to ensure seamless integration with the Goelett SBT API 1.1.

Overall, the Healthcheck API endpoint is designed to make API integration straightforward by providing a clear and concise way to check the health of the system. It allows you to quickly determine whether the SBT system is functioning properly and ready to handle requests, ensuring a smooth and reliable integration experience.

The Search API endpoint allows you to search for specific information within the Goelett SBT system. This feature is particularly useful when you need to locate specific data quickly and efficiently. With the Search API, you can easily find relevant information by providing search parameters such as keywords, filters, or specific criteria.This API endpoint supports a wide range of use cases, including searching for specific items, retrieving a list of matching results, or even narrowing down the search by applying filters. It is designed to provide flexible search options to meet your specific needs.One special feature of the Search API is the ability to perform advanced searches using complex queries. This allows you to combine multiple search parameters and apply logical operators to refine your search results. You can use operators such as AND, OR, and NOT to create more precise queries.Please note that the Search API may return a large number of results depending on the search parameters used. To optimize performance and minimize the response size, you can specify pagination parameters to retrieve results in smaller, manageable chunks.The Search API is an essential tool for integrating the Goelett SBT system with your own applications or services. Its versatility and powerful search capabilities make it easier to locate and retrieve the information you need efficiently.

The Search API endpoint allows you to search for specific information within the Goelett SBT system. This feature is particularly useful when you need to locate specific data quickly and efficiently. With the Search API, you can easily find relevant information by providing search parameters such as keywords, filters, or specific criteria.

This API endpoint supports a wide range of use cases, including searching for specific items, retrieving a list of matching results, or even narrowing down the search by applying filters. It is designed to provide flexible search options to meet your specific needs.

One special feature of the Search API is the ability to perform advanced searches using complex queries. This allows you to combine multiple search parameters and apply logical operators to refine your search results. You can use operators such as AND, OR, and NOT to create more precise queries.

Please note that the Search API may return a large number of results depending on the search parameters used. To optimize performance and minimize the response size, you can specify pagination parameters to retrieve results in smaller, manageable chunks.

The Search API is an essential tool for integrating the Goelett SBT system with your own applications or services. Its versatility and powerful search capabilities make it easier to locate and retrieve the information you need efficiently.

The Travellers API section allows you to retrieve information about travellers. This API endpoint provides various functionalities related to travellers, including retrieving their profile information, contact details, and travel history.By using this API, you can easily integrate traveller-related functionality into your application or system. Whether you need to display traveller profiles, create custom reports based on travel history, or implement features related to contact information, the Travellers API endpoint has you covered.Additionally, this API section includes special features and considerations to enhance your integration experience. You can leverage filters and sorting options to retrieve specific subsets of travellers or organize the results according to your needs. The API also supports pagination, allowing you to efficiently handle large amounts of traveller data.Whether you&apos;re a developer or a non-technical user, integrating the Travellers API section into your project will enable you to seamlessly access and manage traveller information. With its clear documentation and straightforward functionality, integrating this API will be a breeze.

The Travellers API section allows you to retrieve information about travellers. This API endpoint provides various functionalities related to travellers, including retrieving their profile information, contact details, and travel history.

By using this API, you can easily integrate traveller-related functionality into your application or system. Whether you need to display traveller profiles, create custom reports based on travel history, or implement features related to contact information, the Travellers API endpoint has you covered.

Additionally, this API section includes special features and considerations to enhance your integration experience. You can leverage filters and sorting options to retrieve specific subsets of travellers or organize the results according to your needs. The API also supports pagination, allowing you to efficiently handle large amounts of traveller data.

Whether you're a developer or a non-technical user, integrating the Travellers API section into your project will enable you to seamlessly access and manage traveller information. With its clear documentation and straightforward functionality, integrating this API will be a breeze.

The GET Workflowapproval API endpoint in the Goelett SBT API 1.1 project allows you to retrieve information related to workflow approvals. This endpoint is designed to provide a straightforward way to integrate with the Goelett SBT system and retrieve specific workflow approval details.By making a GET request to this endpoint, you can retrieve information such as the status of a particular workflow approval, the associated user or group responsible for the approval, and any relevant timeline or history related to the approval process.This API endpoint is especially useful for developers and non-technical roles who need to access and track the status of workflow approvals within the Goelett SBT system. Whether you are building a custom dashboard for managers to view approval statuses or integrating the workflow approval data into your own application, this endpoint provides a simple and efficient way to fetch the necessary information.It&apos;s important to note that the Workflowapproval endpoint only supports GET requests, so it is read-only and does not allow for any modifications or updates to the approval status. If you require functionality beyond retrieving approval information, please refer to the other sections of the API documentation for appropriate endpoints.To make the integration process even smoother, the Goelett SBT API 1.1 provides comprehensive documentation with detailed examples and explanations of the response structure, parameters, and any authentication requirements. This ensures that developers and non-technical roles can easily understand and implement the necessary code to interact with the Workflowapproval endpoint.By following the guidelines and resources provided in this documentation, you can confidently integrate with the Goelett SBT system and retrieve workflow approval information with ease.

The GET Workflowapproval API endpoint in the Goelett SBT API 1.1 project allows you to retrieve information related to workflow approvals. This endpoint is designed to provide a straightforward way to integrate with the Goelett SBT system and retrieve specific workflow approval details.

By making a GET request to this endpoint, you can retrieve information such as the status of a particular workflow approval, the associated user or group responsible for the approval, and any relevant timeline or history related to the approval process.

This API endpoint is especially useful for developers and non-technical roles who need to access and track the status of workflow approvals within the Goelett SBT system. Whether you are building a custom dashboard for managers to view approval statuses or integrating the workflow approval data into your own application, this endpoint provides a simple and efficient way to fetch the necessary information.

It's important to note that the Workflowapproval endpoint only supports GET requests, so it is read-only and does not allow for any modifications or updates to the approval status. If you require functionality beyond retrieving approval information, please refer to the other sections of the API documentation for appropriate endpoints.

To make the integration process even smoother, the Goelett SBT API 1.1 provides comprehensive documentation with detailed examples and explanations of the response structure, parameters, and any authentication requirements. This ensures that developers and non-technical roles can easily understand and implement the necessary code to interact with the Workflowapproval endpoint.

By following the guidelines and resources provided in this documentation, you can confidently integrate with the Goelett SBT system and retrieve workflow approval information with ease.

Sections