Apparatus and method for structuring a resource of an application programming interface
A system and method of the disclosure relates to structuring at least one resource of an application programming interface (API) for a server. In the method, a plurality of field-level elements may be defined. Each of the plurality of field-level elements may be associated with a respective property. Also, first and second message-level elements may be defined. The first message-level element may be based on a first field-level element of the plurality of field-level elements, and the second message-level element may be based on the first field-level element. The API may be associated with a first resource having properties resolved based on at least the first and second message-level elements.
1. A method for transmitting information via an application programming interface (API) at an onboard server onboard an aircraft, comprising:
storing, at the onboard server onboard the aircraft, a hierarchy of elements comprising:
a plurality of field-level elements including a first field-level element, a second field-level element, and a third field-level element, wherein each of the plurality of field-level elements is associated with a respective property;
a first message-level element based on the first field-level element and the second field-level element of the plurality of field-level elements; and
a second message-level element based on the first field-level element and the third field-level element;
receiving a first request for aircraft information from a ground server external to the aircraft, the first request including a first resource associated with the first message-level element; and
in response to receiving the first request, transmitting, to the ground server via the API at the onboard server, a first response including the first field-level element, the second field-level element, and the first message-level element.
2. The method of claim 1 , further comprising:
storing, at the onboard server, at least one intermediate-level element, wherein each intermediate-level element is based on at least one field-level element, and the first message-level element is based on a first intermediate-level element.
3. The method of claim 2 , wherein the second message-level element is based on the first intermediate-level element.
4. The method of claim 2 , wherein the first intermediate-level element is based on the first field-level element and a fourth field-level element.
5. The method of claim 2 , wherein each intermediate-level element differs from another intermediate-level element by at least one field-level element.
6. The method of claim 2 , wherein the first message-level element is further based on a second intermediate-level element.
7. The method of claim 6 , wherein the second intermediate-level element is based on a fifth field-level element and a sixth field-level element.
8. The method of claim 1 , wherein the first resource comprises an endpoint of the API.
9. The method of claim 1 , wherein each property associated with a field-level element comprises a name-value pair.
10. The method of claim 1 , further comprising:
receiving a second request for aircraft information from the ground server external to the aircraft, the second request including a second resource associated with the second message-level element; and
in response to receiving the second request, transmitting, to the ground server via the API at the onboard server, a second response including the first field-level element, the third field-level element, and the second message-level element.
11. The method of claim 1 , wherein the first field-level element comprises a vehicle identifier.
12. An apparatus for transmitting information via an application programming interface (API) at an onboard server onboard an aircraft, comprising:
means for storing, at the onboard server onboard an aircraft, a hierarchy of elements comprising:
a plurality of field-level elements including a first field-level element, a second field-level element, and a third field-level element, wherein each of the plurality of field-level elements is associated with a respective property;
a first message-level element based on the first field-level element and the second field-level element of the plurality of field-level elements; and
a second message-level element based on the first field-level element and the third field-level element;
means for receiving a first request for aircraft information from a ground server external to the aircraft, the first request including a first resource associated with the first message-level element; and
means for transmitting, in response to receiving the first request and to the ground server via the API at the onboard server, a first response including the first field-level element, the second field-level element, and the first message-level element.
13. The apparatus of claim 12 , further comprising:
means for storing at least one intermediate-level element, wherein each intermediate-level element is based on at least one field-level element, and the first message-level element is based on a first intermediate-level element.
14. The apparatus of claim 13 , wherein the second message-level element is based on the first intermediate-level element.
15. The apparatus of claim 13 , wherein the first intermediate-level element is based on the first field-level element and a fourth field-level element.
16. The apparatus of claim 13 , wherein each intermediate-level element differs from another intermediate-level element by at least one field-level element.
17. The apparatus of claim 13 , wherein the first message-level element is further based on a second intermediate-level element.
18. The apparatus of claim 17 , wherein the second intermediate-level element is based on a fifth field-level element and a sixth field-level element.
19. The apparatus of claim 12 , wherein each property associated with a field-level element comprises a name-value pair.
20. An apparatus for transmitting information via an application programming interface (API) at an onboard server onboard an aircraft, comprising:
a hardware processor configured to:
store, at the onboard server onboard the aircraft, a hierarchy of elements comprising:
a plurality of field-level elements including a first field-level element, a second field-level element, and a third field-level element, wherein each of the plurality of field-level elements is associated with a respective property;
a first message-level element based on the first field-level element and the second field-level element of the plurality of field-level elements; and
a second message-level element based on the first field-level element and the third field-level element;
receive a first request for aircraft information from a ground server external to the aircraft, the first request including a first resource associated with the first message-level element; and
in response to receiving the first request, transmit, to the ground server via the API at the onboard server, a first response including the first field-level element, the second field-level element, and the first message-level element.
21. The apparatus of claim 20 , wherein the hardware processor is further configured to store at least one intermediate-level element, wherein each intermediate-level element is based on at least one field-level element, and the first message-level element is based on a first intermediate-level element.
22. The apparatus of claim 21 , wherein the second message-level element is based on the first intermediate-level element.
23. The apparatus of claim 21 , wherein the first intermediate-level element is based on the first field-level element and a fourth field-level element.
24. The apparatus of claim 21 , wherein each intermediate-level element differs from another intermediate-level element by at least one field-level element.
25. The apparatus of claim 21 , wherein the first message-level element is further based on a second intermediate-level element.
26. The apparatus of claim 25 , wherein the second intermediate-level element is based on a fifth field-level element and a sixth field-level element.
27. The apparatus of claim 20 , wherein each property associated with a field-level element comprises a name-value pair.
28. A non-transitory computer-readable medium onboard an aircraft, comprising:
code for causing a computer onboard an aircraft to store a hierarchy of elements comprising:
a plurality of field-level elements including a first field-level element, a second field-level element, and a third field-level element, wherein each of the plurality of field-level elements is associated with a respective property;
code for causing the computer to store a first message-level element based on the first field-level element and the second field-level element of the plurality of field-level elements; and
code for causing the computer to store a second message-level element based on the first field-level element and the third field-level element;
code for causing the computer to receive a first request for aircraft information from a ground server external to the aircraft, the first request including a first resource associated with the first message-level element; and
code for causing the computer to transmit, in response to receiving the first request and to the ground server via an API at the computer, a first response including the first field-level element the second field-level element, and the first message-level element.
29. The non-transitory computer-readable medium of claim 28 , further comprising code for causing the computer to store at least one intermediate-level element, wherein each intermediate-level element is based on at least one field-level element, and the first message-level element is based on a first intermediate-level element.
30. The non-transitory computer-readable medium of claim 29 , wherein the second message-level element is based on the first intermediate-level element.
31. The non-transitory computer-readable medium of claim 29 , wherein the first intermediate-level element is based on the first field-level element and a fourth field-level element.
32. The non-transitory computer-readable medium of claim 29 , wherein each intermediate-level element differs from another intermediate-level element by at least one field-level element.
33. The non-transitory computer-readable medium of claim 29 , wherein the first message-level element is further based on a second intermediate-level element.
34. The non-transitory computer-readable medium of claim 33 , wherein the second intermediate-level element is based on a fifth field-level element and a sixth field-level element.
35. The non-transitory computer-readable medium of claim 28 , wherein each property associated with a field-level element comprises a name-value pair.