Service Description
asrv.aero
BHS Submit Service v 1.0
Namespace: http://www.asrv.aero/webservices/1.0/BhsSubmitService
1. Service facts
-
Name: BhsSubmitService
-
Operations, see Service operations.
- REST based service. Operations are accessed using HTTPS POST.
- Service security: Decided by implementation.
-
Standard return codes are described here: Service error response
2. Introduction
2.1. Overview
This service description defines one service with a set of operations designed to support the need airports have for bag related information from baggage handling systems (BHS). At the bag level this service slightly extend the functionality in the Baggage Information Exchange Service, and adds functionality for reporting batch oriented events. A "batch" in this regard is a set of bags treated as one "unit" and delivered at some location without any other bags being delivered to the same location.
The service is designed to meet the need of a BHS provider.
A set of use cases are described here: Avinor use cases
2.2. Implementation considerations
Any implementation of this service MUST use the XSD files provided here: XSDs
It is however up to the service provider which data elements to support.
Any service provider should make available documentation about the actual implementation, including:
-
- the address of the service.
- any limitations in the implementation.
2.3. Purpose of this service description
This service description has the following purpose:
-
-
- Describe of service in enough detail for a service provider to implement it.
- Describe the service so that a client (of this service) developer can use it.
- Make available the XSD files necessary to implement and use the service.
- Make it possible for relevant people at airports, airlines, handlers and other aviation partners to understand the available functionality and then to decide if to implement/use it or not.
-
2.4. Intended readership
-
- IT architects
- Developers
- Business architects
- Interested parties in the aviation community
3. Service operations
3.1. Overview
The operations in Avinor Reference Data Submit Service v 1.0 submits reference data that will be synchronously processed. This means that all data will be verified as soon as it is submitted.
3.2. Service error response
ErrorResponseis typically used with HTTP Response Code: 400 Bad Request
|
|
|
3.3. Operations
3.3.1. SubmitAircraftRefData ( AircraftRefDataIn )
Submits the relevant reference data.
Returns
- 200 OK if everything went well. The data is sent on for further processing.
- 400 Bad Request if there were any issues with the input data. The text string returned will give more information about the actual problem.
- Other error/warning returns are possible.
3.3.2. SubmitAirlineRefData ( AirlineRefDataIn )
Submits the relevant reference data.
Returns
- 200 OK if everything went well. The data is sent on for further processing.
- 400 Bad Request if there were any issues with the input data. The text string returned will give more information about the actual problem.
- Other error/warning returns are possible.
3.3.3. SubmitAirportRefData ( AirportRefDataIn )
Submits the relevant reference data.
Returns
- 200 OK if everything went well. The data is sent on for further processing.
- 400 Bad Request if there were any issues with the input data. The text string returned will give more information about the actual problem.
- Other error/warning returns are possible.
3.3.4. SubmitAwosSensorRefData ( AwosSensorRefDataIn )
Submits the relevant reference data.
Returns
- 200 OK if everything went well. The data is sent on for further processing.
- 400 Bad Request if there were any issues with the input data. The text string returned will give more information about the actual problem.
- Other error/warning returns are possible.
3.3.5. SubmitCustomerRefData ( CustomerRefDataIn )
Submits the relevant reference data.
Returns
- 200 OK if everything went well. The data is sent on for further processing.
- 400 Bad Request if there were any issues with the input data. The text string returned will give more information about the actual problem.
- Other error/warning returns are possible.
3.3.6. SubmitHandlerContractRefData ( HandlerContractRefDataIn )
Submits the relevant reference data.
Returns
- 200 OK if everything went well. The data is sent on for further processing.
- 400 Bad Request if there were any issues with the input data. The text string returned will give more information about the actual problem.
- Other error/warning returns are possible.
3.3.7. SubmitHandlerRefData ( HandlerRefDataIn )
Submits the relevant reference data.
Returns
- 200 OK if everything went well. The data is sent on for further processing.
- 400 Bad Request if there were any issues with the input data. The text string returned will give more information about the actual problem.
- Other error/warning returns are possible.
3.3.8. SubmitIataAircraftTypeRefData ( IataAircraftTypeRefDataIn )
Submits the relevant reference data.
Returns
- 200 OK if everything went well. The data is sent on for further processing.
- 400 Bad Request if there were any issues with the input data. The text string returned will give more information about the actual problem.
- Other error/warning returns are possible.
3.3.9. SubmitIcaoAircraftTypeRefData ( IcaoAircraftTypeRefDataIn )
Submits the relevant reference data.
Returns
- 200 OK if everything went well. The data is sent on for further processing.
- 400 Bad Request if there were any issues with the input data. The text string returned will give more information about the actual problem.
- Other error/warning returns are possible.
4. Data entities
4.1. AircraftRefDataIn
Reference data for an aircraft.
4.2. AirlineRefDataIn
Reference data for an airline.
4.3. AirportRefDataIn
Reference data for an airport.
|
|
|
4.4. AwosSensorRefDataIn
Reference data for AWOS (Automated Weather Observing System) sensors.
|
|
|
4.5. CustomerRefDataIn
Reference data for a customer.
|
|
|
4.6. HandlerContractRefDataIn
Reference data for a handler contract.
4.7. HandlerRefDataIn
Reference data for a handler.
|
|
|
4.8. IataAircraftTypeRefDataIn
Reference data for IataAircraftTypeRefDataIn.
|
|
|
4.9. IcaoAircraftTypeRefDataIn
Reference data for IcaoAircraftTypeRefDataIn.
|
|
|
4.10. TransData
|
|
|
5. Avinor use cases
6. XSDs