Service Description

asrv.aero

Passenger Event Submit Service v 1.0

Namespace: http://www.asrv.aero/webservices/1.0/PassengerEventSubmitService/

The service description is a work in progress, and without version control, as long as this note is here.

Document revisions

Date	Description	Author
	First version under version control.	Ole Nymoen

1. Service facts

Name: PassengerEventSubmitService
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 defines a set of operations to submit information about passenger events.

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 Passenger Event Submit Service v 1.0 submits data that typically will be asynchronously processed. This means that all data that follow the syntax will be accepted, but it might not be used by downstream systems.

3.2. Service error response

If a service specific error occurs the entity below will be returned. Any service specific errors will be documented with the actual service implementation.
ErrorResponse is typically used with HTTP Response Code: 400 Bad Request

timestamp: TimestampUTC

Timestamp when the error was generated by the service.

A precise time for when something happened. Always UTC.

serviceErrorCode : ServiceErrorCode

An integer code representing a service specific error. The actual values are described in the service definition.

serviceErrorDescription: ServiceErrorDescription

A textual description of ServiceErrorCode.

3.3. Operations

3.3.1. SubmitPassengerEventData( PassengerEventDataIn )

Submits an event, PassengerEventData, indicating something related to the passenger. This can for instance be the passenger location at the given time.

Parameters

PassengerEventDataIn

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. Service error response defies how to get more information about the actual problem.
Other error/warning returns are possible.

4. Data entities

4.1. PassengerEventData

Airport code where the boarding pass was scanned (e.g. OSL)
N/A Terminal where the boarding pass was scanned (not relevant for Avinor airports)
The carrier code encoded in the boarding pass (for example DY)
The flight number encoded in the boarding pass (for example 1256)
The departure date of the flight
The security number of the passenger (for example 135)
The date and time in UTC when the boarding pass was scanned.
where the boarding pass was scanned (SECURITY, FAST TRACK, Domestic Transfer)

NB! Alle ReDok-data ønskes.

FIGUR SOM VISER DATASETTET

ADD Term	Description
PassengerEventAirportIATA	The airport where the passenger event happened
PassengerEventCode	Hvilken event
PassengerEventDescription	Nærnere beskrivelse
PassengerEventTimestamp	Tidspunktet
PassengerEventDuration	Hvor lang tok tok eventen
PassengerEventLocation	Lokasjonskode
PassengerEventLocationDescription	Lengre beskrivelse av lokasjonen

FlightId
SOBT

BoardingPassSeqNumber