Package aero.loretta.client.api

Interface LorettaApi

public interface LorettaApi

Loretta API client for accessing public Loretta API.

For creating instance of Loretta API client, please use LorettaApiFactory

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	LorettaApi.UploadResponse	Standard API response

Method Summary

Modifier and Type	Method	Description
default LorettaApi.UploadResponse	uploadEff(byte[] eff)
default LorettaApi.UploadResponse	uploadEff(byte[] eff, String gufi)
LorettaApi.UploadResponse	uploadEff(byte[] eff, String gufi, List<String> employeeIds)	Extract ARINC633 flightplan from EFF package and calls uploadFlightPlan(String, String, List)
default LorettaApi.UploadResponse	uploadEff(byte[] eff, List<String> employeeIds)
default LorettaApi.UploadResponse	uploadFlightPlan(String flightPlan)
default LorettaApi.UploadResponse	uploadFlightPlan(String flightPlan, String gufi)
LorettaApi.UploadResponse	uploadFlightPlan(String flightPlan, String gufi, List<String> employeeIds)	Upload ARINC633 Flightplan to Loretta system.
default LorettaApi.UploadResponse	uploadFlightPlan(String flightPlan, List<String> employeeIds)

Method Details

uploadFlightPlan

default LorettaApi.UploadResponse uploadFlightPlan(String flightPlan)
                                            throws LorettaClientException

Throws:

LorettaClientException

See Also:

• uploadFlightPlan(String, String, List)

uploadFlightPlan

default LorettaApi.UploadResponse uploadFlightPlan(String flightPlan,
 String gufi)
                                            throws LorettaClientException

Throws:

LorettaClientException

See Also:

• uploadFlightPlan(String, String, List)

uploadFlightPlan

default LorettaApi.UploadResponse uploadFlightPlan(String flightPlan,
 List<String> employeeIds)
                                            throws LorettaClientException

Throws:

LorettaClientException

See Also:

• uploadFlightPlan(String, String, List)

uploadFlightPlan

LorettaApi.UploadResponse uploadFlightPlan(String flightPlan,
 String gufi,
 List<String> employeeIds)
                                    throws LorettaClientException

Upload ARINC633 Flightplan to Loretta system. This will create or update flightplan in Loretta system, whereby for update GUFI needs to match the GUFI that was used to upload flightplan for first time.

If your flightplan does not contain GUFI (FlightKeyIdentifier), then you MAY provide it as argument. Provided GUFI should be either UUID or it should be prefixed with your operator ICAO code. If you don't provide GUFI and your flightplan does not contain it, then API client itself will generate GUFI out of flight data in form of ${OPERATOR}-${STD}-${CALLSIGN}-${DEP}-${DST}.

Parameters:

flightPlan - ARINC633 Flightplan in XML format

gufi - (Optional) The gufi of flightplan

employeeIds - (Optional) The ids of employees

Returns:

LorettaApi.UploadResponse in case of success

Throws:

LorettaClientException - when API fails or provided arguments are invalid

uploadEff

default LorettaApi.UploadResponse uploadEff(byte[] eff)

See Also:

• uploadEff(byte[], String, List)

uploadEff

default LorettaApi.UploadResponse uploadEff(byte[] eff,
 String gufi)
                                     throws LorettaClientException

Throws:

LorettaClientException

See Also:

• uploadEff(byte[], String, List)

uploadEff

default LorettaApi.UploadResponse uploadEff(byte[] eff,
 List<String> employeeIds)
                                     throws LorettaClientException

Throws:

LorettaClientException

See Also:

• uploadEff(byte[], String, List)

uploadEff

LorettaApi.UploadResponse uploadEff(byte[] eff,
 String gufi,
 List<String> employeeIds)
                             throws LorettaClientException

Extract ARINC633 flightplan from EFF package and calls uploadFlightPlan(String, String, List)

Throws:

LorettaClientException