Infographic
Infographics are included as part of the photo
list by default when responding to a request for UPAs. You can explicitly request infographics by setting "disable_upa_infographics": false
.
You can also request that infographics not be returned with UPAs by setting "disable_upa_infographics": true
.
// Use "disable_upa_infographics" key in request body:
{
"control": {
"includes": [
"upa" // response should return UPAs
],
"disable_upa_infographics": false, // use true to omit UPA infographics from the response
// optional, defaults to false
// ...
}
// ...
}
Response
General Attributes
These attributes apply to photo, video, and tour UPAs.
Attributes | Type | Description/Value |
---|---|---|
headline | string | Headline, up to 40 characters |
description | string | Description, up to 140 characters |
small_icon_url | string | URL for the 42x42 icon |
large_icon_url | string | URL for the 84x84 icon |
cta_text | string | Link text for cta_url |
cta_url | string | External URL where the end user can learn more |
categories | array | Category IDs for Flight: aircraft, seat, meals, beverages, entertainment, power, wi-fi, service-inflight, upgrade. Other additional Category IDs : transport-to-airport, check-in, departure-terminal, department-lounge, gate-boarding, service-departure, stopover, connecting-ease, connecting-terminal, connecting-lounge, service-connecting, baggage-collection, arrival-terminal, arrival-lounge, arrival-transport, service-arrival, schedule-route, loyalty-program, brand, promotion. |
fees | array | Additional fees. Elements are objects with members: currency_code (string), amount_min (string), amount_max (string or null) |
source | string | The source of the UPA. Possible values include: ATPCO or airline |
Infographic-specific Attributes
These attributes apply to photo UPAs.
Attributes | Type | Description/Value |
---|---|---|
alt_text | string | The alternative text for the Photo |
caption | string | Photo caption |
thumb_url | string | URL to the 150x150 image |
medium_square_url | string | URL to the 350x350 image |
large_url | string | URL to the large image (no wider than 800px and or taller than 600px, scaled proportionately) |
url | string | URL to the original image |
media_type | enum | The type of the specific piece of media |