Name | Description |
---|---|
GET | Used for retrieving user details. |
POST | Used for creating & searching user, or performing custom actions. |
DELETE | Used for deleting user. |
PUT | Used for updating user profiles. Complete user profile is supposed to be sent. |
PATCH | Used for updating specific fields in the user profile. The operations supported are "add", "remove" and "replace". |
Name | Description |
---|---|
200 | OK |
204 | No Content |
400 | Bad Request |
403 | Forbidden |
404 | Not Found |
422 | Unprocessable Entity |
400 | Bad Request |
500 | Internal Server Error |
503 | Service Unavailable |
Name | Description |
---|---|
HH | Hilton Honors |
LO | Langham Hotels 1865 |
PS | Sandman StatusPlus |
LU | Montcalm club |
HQ | B&B e-club program |
TRI | Trident |
HR | Total Rewards |
DO | Dorint Card |
DR | Drury Rewards |
YH | beOne |
HY | Hyatt: World of Hyatt |
UI | Catalonia Rewards |
MC | Marriott Bonvoy
Marriott BonVoy |
TRU | Trump Card Privileges Program |
QH | breakaway club |
QI | Choice Privileges |
EA | Extended Perks |
MK | Movenpick Circle M
Mövenpick Circle M |
YX | CitizenM Hotels |
MM | PartnerCard |
MO | Fans of MO |
EI | Executive Rewards Club |
MS | Magnuson Rewards |
MU | Millennium: My Millennium |
MV | MGM Mlife Rewards |
QUO | Quorum |
RA | Wyndham Rewards |
RD | Radisson Rewards |
EW | Elite Hotels Rewards |
RF | Red Roof RediRewards |
RG | Priority Guest Rewards |
AZ | Ascott Online Advantage Member |
JD | Discovery Loyalty |
RL | Red Lion Hello Rewards |
FH | Fiesta Rewards |
RT | Accor Hotels Business Plus
Accor Hotels Live Limitless |
NS | NH Rewards |
JT | Jumeirah Sirius
Sirius (Jumeirah) |
JV | Joy of Life Club
The Joy of life Club |
BN | my Barcelo |
BP | Star Rewards |
SD | Silver Cloud Silver Rewards |
FX | First Member |
SF | Prestige |
C6 | IHG Rewards Club |
SG | Golden Circle
Shangri La Golden Circle |
WK | Warwick Journeys |
BW | Best Western Rewards |
SH | Scandic Friends |
WM | Westmark Guest Rewards |
OG | The Originals Club |
SK | SibySilken |
SM | MeliáRewards
MeliaRewards |
SN | Sonesta Travel Pass |
AAAF | CHOICE PRIVILEGES |
T1 | Nordic Choice Club |
OM | Omni Select Guest
SELECT GUEST |
T2 | Golden Tulip Flavours |
ON | Valk Loyal |
SR | Award World |
T3 | Jurys Rewards |
WW | Peakpoints |
T4 | S-Card |
WX | Coast Rewards |
T6 | Tsogo Sun Hotels Rewards |
T7 | Grand Chancellor GC Rewards |
T8 | Lotte Hotel Rewards |
T9 | SBE The Code |
SX | ARP Hansen |
GO | Boomerang Returns Reward Program |
GS | GrandStay Grand Returns |
GT | Pass for You
Pass for you |
CQ | CQ Rewards
Club quarters Gold Rewards |
TD | TFE Hotels eClub |
TH | Trump Card |
TI | YourThistle |
TJ | Taj InnerCircle |
LD | Leonard AdvantageClub |
PH | iPrefer |
HA | HOTUSA PLUS |
LG | Lidner Nights |
TQ | H-Hotels.com Loyalty Program |
Name | Description |
---|---|
CF | Half-Fare travelcard |
2V | Amtrak Guest Reward Card |
MTR | Club Xpress |
FS | CartaFRECCIA |
ES | Club Eurostar
Eurostar |
2A | BonusCard Business
Bonus Card |
SC | Senior+
Abonnement Général (AG) + Fréquence First
Enfant +
Abonnement Général (AG) + Forfait First
Abo demi-tarif + Fréquence First
Abo demi-tarif + Forfait First
Carte Liberté
Militaire First
Frequence First
Forfait First
Frequence 30 First
Abonnement Général (AG) demi-tarif
Carte Avantage Famille
Abonnement Général (AG) First
Carte Avantage Week-End
Carte Famille Militaire
Carte Avantage Senior
Carte Enfant Famille
Frequence 30 Second
Week-end
Carte Avantage Jeune
Abonnement Général (AG) Second
Jeune
Abo demi-tarif + Forfait Second
Abo demi-tarif + Fréquence Second
Abonnement Général (AG) + Forfait Second
Abonnement Général (AG) + Fréquence Second
Forfait Second
Frequence Second
Militaire Second |
2C | Grand Voyageur/Grand Voyageur Le Club |
RE | +RENFE |
22.0 | S Miles non SNCF |
ITA | Italo PIU |
SJ | SJ Prio |
YS | My Thalys World
Thalys Premium pass
Thalys Frequent pass |
NSB | Kundekort |
Name | Description |
---|---|
LC | Loyalty card |
SC | Subscription card |
Name | Description |
---|---|
AIR | Air - Line of business |
CAR | Car - Line of business |
HOTEL | Hotel - Line of business |
RAIL | Rail - Line of business |
Name | Description |
---|---|
141 | No Special Meal |
142 | No meal |
143 | Baby meal |
144 | Diabetic |
145 | High Fiber |
146 | Low-calorie |
147 | Low Protein |
148 | Oriental (Asian) |
149 | Seafood |
150 | Vegetarian dairy/egg meal |
151 | Bland |
152 | Fruit Platter |
153 | Vegetarian meal |
154 | Low sugar meal |
155 | Low Sodium |
156 | Low Purine |
157 | Vegetarian non-dairy meal |
158 | Child meal |
159 | Gluten-free |
160 | Kosher |
161 | Low-fat |
162 | No Lactose |
163 | Raw Veggie/Fruit |
164 | Halal |
165 | Vegetarian |
166 | Pure Vegetarian |
167 | Vegetarian Oriental |
168 | Japanese-style |
169 | Vegetarian hindu meal |
170 | Vegetarian jain meal |
171 | Diabetic |
172 | Indian vegetarian meal (ua specific) |
173 | Kosher |
174 | No fish |
175 | Japanese obento meal (ua specific) |
176 | Special meal |
177 | Standard |
178 | Vegan meal |
179 | Vegetarian lacto-ovo meal |
180 | Low-lactose |
181 | Low-salt |
182 | Vegetarian oriental meal |
183 | Non-vegetarian Hindu |
Name | Description |
---|---|
0 | Facing forward - No |
1 | Facing forward - Yes |
Name | Description |
---|---|
1 | Mr. (supported for EU + CA point of sale) |
2 | Ms. (supported for EU + CA point of sale) |
3 | Mrs. (supported for EU + CA point of sale) |
4 | Miss (supported for EU + CA point of sale) |
5 | Master (supported for EU + CA point of sale) |
9 | Dr. (supported for CA point of sale) |
10 | Prof. (supported for CA point of sale) |
11 | Mr. Dr. (supported for EU point of sale) |
12 | Mrs. Dr. (supported for EU point of sale) |
13 | Mr. Prof. (supported for EU point of sale) |
14 | Mrs. Prof. (supported for EU point of sale) |
33 | Mrs. Dr. Prof. (supported for EU point of sale) |
34 | Mr. Dr. Prof. (supported for EU point of sale) |
35 | Lady (supported for EU point of sale) |
36 | Sir (supported for EU point of sale) |
37 | Lord (supported for EU point of sale) |
38 | Ms. Dr. (supported for EU point of sale) |
39 | Ms. Prof. (supported for EU point of sale) |
40 | Ms. Dr. Prof. (supported for EU point of sale) |
Name | Description |
---|---|
Mr. | supported for EU + CA point of sale |
Ms. | supported for EU + CA point of sale |
Mrs. | supported for EU + CA point of sale |
Miss | supported for EU + CA point of sale |
Master | supported for EU + CA point of sale |
Dr. | supported for CA point of sale |
Prof. | supported for CA point of sale |
Mr. Dr. | supported for EU point of sale |
Mrs. Dr. | supported for EU point of sale |
Mr. Prof. | supported for EU point of sale |
Mrs. Prof. | supported for EU point of sale |
Mrs. Dr. Prof. | supported for EU point of sale |
Mr. Dr. Prof. | supported for EU point of sale |
Lady | supported for EU point of sale |
Sir | supported for EU point of sale |
Lord | supported for EU point of sale |
Ms. Dr. | supported for EU point of sale |
Ms. Prof. | supported for EU point of sale |
Ms. Dr. Prof. | supported for EU point of sale |
Name | Description |
---|---|
0 | No preference |
1 | Non-smoking |
2 | Smoking |
Name | Description |
---|---|
NORMAL | Receive emails for my trips only, including e-ticket emails. |
NONE_EXCEPT_MY_ETICKETS | Never receive emails except e-tickets emails for my trip. |
Name | Description |
---|---|
WORK | The email address provided is associated with work. |
HOME | This is not supported at the moment. |
Name | Description |
---|---|
MOBILE | The contact address represents the user's home address. |
Name | Description |
---|---|
MOBILE | The specified contact number is a mobile/cell phone type. |
WORK | The specified contact number belongs to the work/office. |
HOME | The specified contact number belongs to the home. |
Name | Description |
---|---|
SELF_BOOKER | Can book travel for self - Self booker rights |
ARRANGER | Can book travel for other travelers of the organization who are associated as arrangee |
APPROVER | Can approve bookings for other travelers |
FLEXIBLE_ARRANGER | Can book travel for all the other travelers of the organization |
GUEST_MANAGER | Can manage profiles & bookings for the global guest travelers |
MANAGE_USERS | Can manage other users within the company |
Name | Description |
---|---|
0 | Any |
1 | Window |
2 | Aisle |
Name | Description |
---|---|
PAS | Passport |
ID | Identification card |
DL | Driving license |
HR_PERMIT | Home return permit |
TWC_PERMIT | Taiwan compatriot permit |
EEP_HW | Entry-exit permit for hm |
TP_TW | Travel permit for taiwan |
ID_ARMY | Army identification |
PRI_FOREIGNER | Permanent resident card |
ID_DIPLOMATIC | Diplomatic identification |
ID_BIRTH | Birth identification/certificate |
DOM_TC | Domestic travelling card |
Name | Description |
---|---|
0 | Seat solo - No |
1 | Seat solo - Yes |
Name | Description |
---|---|
NORMAL | This specifies that the requested user is a normal user who can book and manage. |
GUEST | This specifies that the requested user is of type guest. |
Name | Description |
---|---|
FIRST | First class |
SECOND | Second class |
Name | Description |
---|---|
LOGIN | This attribute specifies that the user's authentication mode is login with Egencia. |
SSO | This attribute specifies that the user's authentication mode is SSO. (Single sign-on) |
Name | Description |
---|---|
PR | Philippine Airlines
Philipine Mabuhay Miles |
PS | Ukraine International Panorama Club
Panorama Club |
/T | Germanwings Boomerang Club |
PU | Pluna Smiles |
PV | Latvian Airlines |
PW | Paa Royal |
PX | Destinations
Destinations Executive Club |
PZ | TAM Mercosur Fidelidade |
A3 | Aegean Miles & Bonus
Miles & Bonus |
A5 | HOP
Airlinair Flying Blue
Carte Jeune HOP |
QF | Qantas Airways
Qantas Frequent Flyer |
A7 | Club Air Comet |
AA | AAdvantage
American - AAdvantage
American - AAdvantage Executive Platinum
American - AAdvantage Gold
American - AAdvantage Platinum
American - AAdvantage Platinum Pro |
AB | airberlin topbonus
Air Berlin |
R3 | Armenian Airlines |
QR | Qatar Airlines Privilege Club
Privilege Club |
AC | Air Canada Aeroplan
Aeroplan |
AD | Air Azul (Azul Linhas Aereas Brasileiras)
Air Azul |
AE | Mandarin Dynasty Flyer |
AF | Abonnement DOM (Antilles-Guyane-Réunion) (RPDOM)
Air France Flying Blue
Abonnement FR-Europe-Afrique du Nord+DOM (RPDOMFM)
Abonnement FR-Europe-Afrique du Nord (RPFM)
Air France (weekend)
Flying Blue
Air France (SENIOR)
Club 2000
Carte Jeune |
R7 | Aserca Airlines Privilege |
AH | Air Algerie Plus
Air Algerie |
AI | Air India
Air India Flying Returns |
AK | Air Asia |
AM | Aeromexico Club Premier
Aeromexico |
B0 | MyCompagnie
LA COMPAGNIE |
AP | Air One Qualiflyer
Air One |
B2 | Belavia Airlines
Belavia |
AR | Aerolineas Plus
Aerolineas Argentinas |
RC | Atlantic Airways |
AS | Alaska Airlines
Alaska MVP Gold 75K
Alaska MVP Gold 100K
Alaska - MVP
Alaska - MVP Gold
Alaska Mileage Plan |
RE | Aer Arann Silver Club
Aer Arann Teo |
AT | Royal Air Marco Safar Flyer |
B6 | JetBlue TrueBlue
JetBlue |
AV | Avianca
Avianca Plus |
RG | Varig |
RJ | Royal Jordanian Royal Plus
Royal Jordanian |
AY | Finnair Plus |
AZ | Millemiglia
Alitalia MilleMiglia Club |
RK | Air Afrique |
RO | Tarom Smart Miles |
RP | Precision Airlines |
BA | British Airways Executive Club
EXECUTIVE CLUB |
S2 | JetPrivilege (Jet Lite) |
S4 | SATA Imagine |
BD | bmi diamond club |
BE | Rewards4all
Flybe Rewards 4 All |
S7 | Siberia Airlines Priority |
BI | Royal Skies
Royal Brunei Airlines |
BM | BMI REGIONAL |
SA | South African Airways Voyager
South African Airways |
SB | Air Calin Flying Blue |
BQ | Aeromar C. Por. A. |
BR | EVA Air Infinity MileageLands
Evergreen Club |
BT | BalticMiles
Air Baltic EuroBonus |
2D | Southeast Airlines |
BW | Bwia International
Caribbean Miles |
C9 | Cirrus Miles & More |
BY | Britannia Airways |
SK | Eurobonus
Travel Pass Multiple Punch
TPC
Travel Pass Punch personal
SAS EuroBonus
Travel Pass Multiple
Travel Pass Unlimited |
2K | Aeromillas |
SN | Brussels Airlines Privilege
Loop |
SP | Sata - Air Acores |
CA | Air China Phoenix Miles
Air China International |
SQ | Krisflyer
Singapore Airlines KrisFlyer |
SR | Swissair
Qualiflyer |
SS | Club Corsair
Abonnement Grand Large |
SU | Aeroflot Bonus |
T7 | Twin Jet Flying Blue
Abonnement Twin Jet |
SV | Alfursan
Saudi Arabian Airlines Alfursan |
SW | Air Namibia
Air Namibia Reward$ |
CH | Bemidji Airlines |
SY | Sun Country Ufly |
CI | China Airlines Dynasty Flyer |
CM | MileagePlus
Copa ConnectMiles |
CO | Continental Airlines
One Pass |
TA | Taca International Airlines
Taca Distancia |
CP | Canadian Airlines |
3A | Alliance Airlines |
TE | Lithuanian Airlines |
TF | ARSKORT HELA LINJENATET
ARSKORT ENBART VISBY
BRA
HALVARSKORT ENBART VISBY
HALVARSKORT HELA LINJENATET |
TG | Thai Royal Orchid Plus
Royal Orchid Plus |
TH | BRITISH AIRWAYS CITIEXPRESS |
CX | Cathay Pacific Asia Miles
Asia Miles
MarcoPolo |
CY | Cyprus Airways
Cyprus Airways SunMiles |
3J | Air Alliance |
CZ | China Southern Sky Pearl Club
China Southern Airlines |
TK | Miles & Smiles
Turkish Airlines |
TM | LAM Mozambique Airlines Flamingo Club |
TN | Air Tahiti Nui Club Tiare
Air Tahiti Nui |
TP | TAP Air Portugal Navigator
Tap - Air Portugal |
U2 | EASYJET PLUS |
TS | Air transat |
U6 | Ural Airlines Travelling Club "Wings" |
TU | Tunis Air Fidelys
Tunis Air |
DE | Condor Flugdienst Gmbh
Condor Miles & More |
3U | Sichuan Airlines card
Sichuan Airlines Golden Panda |
TV | Virgin Express |
TW | Trans World Airlines |
TX | Caribbean Frequent Flyer
Atlantique
Air Caribbean
Flexil |
DI | Deutsche Ba |
DJ | Virgin Blue Velocity Rewards |
TZ | ATA Travel Awards |
DL | Delta - Diamond Medallion
Delta - Gold Medallion
Delta - Platinum Medallion
Delta SkyMiles
Delta - Silver Medallion
Sky Miles |
E0 | Eos Airlines |
UA | Mileage Plus
United Mileage Plus |
UD | Hex Air |
DS | Air Senegal |
UE | Air L.a. |
DT | Taag - Linhas Aereas De Angola |
DX | Danair |
DY | Norwegian Air
Norwegian Reward |
UK | Air Uk |
UL | Srilankan Airlines
Air Lanka Serendib Club |
UM | Air Zimbabwe Rainbow Club |
4L | Air Alma |
4M | Lanargentina LANPASS |
UN | Transaero Airlines
Transaero Privilege Program |
UO | Hong Kong Express Fortune Wings Club |
UP | Bahamasair |
US | US Airways - Chairman Preferred
US Airways - Gold Preferred
Dividend Miles
US Airways - Silver Preferred
US Airways Dividend Miles
US Airways - Platinum Preferred |
UU | CAPRICORNE
Air Austral Capricorne
Capricorne |
EE | Euroberlin |
4U | GermanwingsBoomerang Club
Boomerang Club |
V7 | MEGAVOLOTEA |
4V | Voyageur Airways |
UW | Perimeter Aviation |
UX | Air Europa Flying Blue
AIR EUROPA SUMA |
EI | Aer Lingus Travel Award Bonus (TAB)
Aer Lingus
Aer Lingus - Aer Club |
EK | Emirates Skywards
SKYWARDS |
EL | Air Nippon |
EN | Air Dolomiti Miles & More
Air Dolomiti |
VA | V Australia Velocity Rewards
Velocity Rewards |
ET | Ethiopian Sheba Miles
Ethiopian Airlines |
VF | British World Airlines |
VG | VLM Airlines Encore
Vlm Vlaamse |
EW | Eurowings |
VH | Aeropostal Aeropass |
F9 | Frontier Airlines
Frontier Airlines EarlyReturns |
EY | Etihad Guest Miles
Etihad Guest |
5J | Private Jet Expeditions |
5L | Club Aerosur |
VN | Vietnam Airlines Golden Lotus Plus
Vietnam Airlines |
VO | Tyrolean Airways |
FB | Bulgaria Air FlyFB Bonus Points
Balkan Air Tour |
VR | TACV Cabo Verde Airlines |
VS | Virgin Flying Club
Flying Club |
VU | Air Ivoire |
W6 | PRIVILEGE PASS |
5T | Canadian North Aeroplan |
VV | Meridian Gold Card |
VX | Aces - Aerolineas Centrales De Colombia
eleVAte
Virgin America Elevate |
FI | Icelandair |
VY | Vueling Club |
FL | A+ Star Rewards
AirTran A+ rewards
Airtran Airways |
FM | Crane Club
Shanghai Airlines Crane Club |
FN | Regional Airlines |
FQ | Brindabella - Qantas Frequent Flyer |
G3 | Gol Smiles
Smiles |
FR | Ryanair |
WF | Widerøe Eurobonus |
6E | Indigo |
FU | Air Littoral |
FZ | Open |
WN | Rapid Rewards
Southwest Airlines Rapid Reward |
WP | Island Air Cloud 9 |
GA | Garuda Indonesia
Garuda Frequent Flyer |
X3 | TUIfly.com |
WS | WestJet Dollars
Westjet |
X5 | Afrique Airlines |
GE | TransAsia Airways Premium Membership |
GF | Falcon
Gulf Air Company
Gulf Air |
WY | Oman Sinbad Frequent Flyer
Oman Air |
GJ | Eurofly Hi-Fly |
GQ | Big Sky Airways |
GR | Aurigney Air |
XF | Vladivostok Leader |
7F | First Air Aeroplan |
XK | Air Corsica |
XL | Lanecuador LANPASS |
7L | AB Airlines |
XQ | Action Airlines |
HA | Hawaiian Airlines HawaiianMiles
Hawaiian Airlines |
HB | ASIA ATLANTIC MILES |
XS | S.i.t.a |
XT | KLM EXEL |
HF | HAPAG LLOYD |
HG | Niki topbonus |
HM | Air Seychelles |
HO | Airways International |
HP | America West Airlines |
8A | Americana De Aviacion |
HU | Hainan Fortune Wings Club
Hainan Airlines |
HX | Fortune Wings Club
Hong Kong Airlines Fortune Wings Club |
HY | Uzbekistan Airways |
YM | Vision Team
Montenegro Airlines Vision Team |
8M | MNA Club |
YN | Air Creebec Aeroplan |
YP | Aero Lloyd |
IB | Iberia Plus |
IC | Indian Airlines Flying Returns
Indian Airlines |
IG | Meridiana
Meridiana Hi-Fly |
YX | Midwest Miles
Midwest Express Airlines |
IJ | Air liberte |
ZB | Monarch Vantage Club
Monarch Airlines |
J2 | AZAL-Miles |
9A | Air Atlantic |
IR | IranAir SkyGift |
IT | Air Inter
King Club |
9F | Eurostar - UK user |
IW | Aom French Airlines
Air Lib |
ZI | Aigle Azur Plus
Azur Plus |
IY | Yemenia Yemen Airways Arabia Felix Club |
ZL | Rex Flyer
Regional Express Rex Flyer |
JC | Jal Express Mileage Bank |
JG | Swedair |
9W | Jet Privilege
Jet Airways Limited |
JJ | TAM Linhas Aereas
Tamfiledade |
JK | Spanair Plus |
JL | Japan Airlines Mileage Bank
JAL Mileage Bank |
JM | Air Jamaica
Air Jamaica 7th Heaven |
JO | Jalways Mileage Bank |
JP | Adria Miles & More |
JQ | Jetstar Airways Qantas Frequent Flyer |
JR | Aero California |
JU | Jat Miles & More |
JZ | Skyways |
KA | Dragon Airlines The Elite
Dragonair |
KC | Nomad Club
Air Astana Nomad Club |
KE | Skypass
Korean Airlines Skypass |
KF | Blue1 Eurobonus |
KK | Tam Regional |
KL | KLM Flying Blue
KLM BlueBiz |
KM | Air Malta |
KQ | Kenya Airways
Kenya Airways Flying Blue |
KS | PenAir Alaska Mileage Plan |
KU | Oasis Club Home
Kuwait Airways Oasis Club |
KX | Cayman Sir Turtle Rewards |
KZ | Nippon Cargo Airlines |
LA | Lan Chile
Lan Airlines LANPASS |
LB | Lloyd Aereo Boliviano Lider Club |
LG | Luxair Miles & More |
LH | Lufthansa Miles and More
Miles And More |
LI | Liat |
LM | Clan Loganair |
LO | LOT Miles & More
Miles & More |
LP | Lan Peru LANPASS |
LR | Lacsa Distancia |
LT | LTU topbonus |
LV | Aeropostal |
LX | Swiss Miles& More |
LY | El Al Matmid Club
El Al Israel Airlines |
LZ | Balkan Bulgarian Airline |
MA | Malev Duna Club
Malev - Hungarian Airlines |
MD | Air Madagascar Namako |
ME | Middle East Cedar Miles
Middle East Airlines |
MF | Egret Card |
MH | Enrich
Malaysia Airlines - Enrich |
MI | Silk Air KrisFlyer |
MK | Air Mauritius |
MM | Sociedad Aeronautica De Medellin |
MS | EgyptAir Plus |
MU | China Eastern Airlines
China Easternmiles |
N6 | AERO CONTINENTE |
MX | MEXICANA FRECUENTA MILES
Breeze Airways BreezePoints Rewards Program |
MY | MaxJet |
MZ | Merpati Nusantara |
NF | Air Vanuatu -Qantas Frequent Flyer |
NG | Lauda Air |
NH | Ana mileage club
All Nippon Mileage Club |
NI | Portugalia |
NK | Spirit Airlines Free Spirit |
NT | Binter Canarias |
NU | SWL Transocean |
NW | Northwest WorldPerks
Northwest Airlines |
NX | Nationair Canada
Air Macau Privileges |
NZ | Air New Zealand
Air New Zealand Air Points |
OA | Olympic Airlines
Olympic Airlines Icarus |
OD | Malindo miles |
OG | Air Guadeloupe |
OK | OK Plus
Czech OK Plus |
OM | Miat Mileage |
OS | Austrian Miles & More |
OU | Croatia Miles & More |
OV | Estonian Air EuroBonus |
OZ | Asiana Club |
PD | Porter Airlines VIPorter |
PG | FlyerBonus
Bangkok Airways FlyerBonus |
/I | Air Berlin Top Bonus |
PK | Pakistan Awards Plus |
PL | Aeroperu |
Name | Description |
---|---|
FG | Firefly DE |
BD | Buchbinder Germany |
PT | Thrifty Canaries |
FU | Firefly EU |
FX | Fox Rental Cars |
OK | Ok Rent A Car
OK Mobility |
AC | ACE Rent A Car |
AD | Advantage
Advantage Rent-A-Car |
SX | Sixt Express
Sixt Accreditive
Sixt |
CI | Citer |
ZA | Payless |
OX | ORYX Rent A Car |
ZD | Budget |
ZE | Hertz Accreditive
Hertz |
EP | Europcar Accreditive
Europcar |
AL | Alamo
Alamo Rent A Car |
ET | Enterprise Plus
Enterprise |
ZI | Avis
Avis Accreditive |
ZL | National Car Rental
National
Emerald Club
National Citer - Emerald Accreditive
National Citer |
AT | Atesa |
EY | Economy Rent a Car |
CY | City Rent A Car |
NE | Nationwide |
ZR | Dollar
Dollar Rent A Car |
ZS | Sears |
ZT | Thrifty Car Rental
Thrifty |
ZU | Auto Europe |
TO | Thrifty EU |
MG | Maggiore Club |
Name | Description |
---|---|
0 | No preference |
1 | Window |
3 | Aisle |
Code | Description |
---|---|
400 | Request body cannot be read as it does not comply with expected schema. |
403 | Unauthorised access, you do not have sufficient permissions to perform an action. |
404 | User not found, you are trying to access an invalid or non existent user. |
422 | Invalid or missing parameters encountered due to which we are unable to process your request. |
500 | Your request could not be completed due to some error. Please try again later. |
503 | Service Unavailable. Please try again later. |
S.No. | Attribute | Required | Type | Description |
1 | country | Yes | string | The value of the user address country. It should be 3 letters (alpha-3) or 2 letters (alpha-2) ISO country code of the address. This field is mandatory and cannot be empty. Version 1 of the APIs support 3 letter country code while version 2 supports 2 letter country code |
2 | formatted | No | string | The formatted address value. |
3 | locality | No | string | The locality of the contact address. |
4 | postalCode | Yes | string | The postal code of the address. This field is mandatory and cannot be empty. |
5 | region | Yes | string | The region or city of the contact address. This field is mandatory and cannot be empty. |
6 | streetAddress | Yes | string | The value of the street address or address line 1. This field is mandatory and cannot be empty. |
7 | type | Yes | string | The type of physical address. |
S.No. | Attribute | Required | Type | Description |
1 | delegateApprovers | No | Multi-Valued (ApproverSchemaV2) | Delegate Approver details for the user. Delegate Approver of a user must already exist and its unique id needs to be passed to associate that as a delegate to a user with Approver role |
2 | level1Approvers | No | Multi-Valued (ApproverSchemaV2) | Level 1 approvers associated with the user. |
3 | level2Approvers | No | Multi-Valued (ApproverSchemaV2) | Level 2 approvers associated with the user. |
S.No. | Attribute | Required | Type | Description |
1 | delegateApprovers | No | Multi-Valued (string) | Delegate Approver details for the user. Delegate Approver of a user must already exist and its unique id needs to be passed to associate that as a delegate to a user with Approver role |
2 | level1Approvers | No | Multi-Valued (string) | Level 1 approvers associated with the user. |
3 | level2Approvers | No | Multi-Valued (string) | Level 2 approvers associated with the user. |
S.No. | Attribute | Required | Type | Description |
1 | id | No | string | User id of the approver associated with the user. |
2 | userName | No | string | Username of the approver associated with the user. |
S.No. | Attribute | Required | Type | Description |
1 | id | No | string | User id of the arranger associated with the user. |
2 | userName | No | string | Username of the arranger associated with the user. |
S.No. | Attribute | Required | Type | Description |
1 | primary | No | boolean | Identifier flag to determine whether the contact is primary or not. |
2 | type | Yes | string | The type of contact e.g. home, work, mobile, etc. |
3 | value | Yes | string | The value of the contact in international format. The number should follow this pattern : +[country code]-[area code][phone number] eg. +44-1234512345, or +[country code][area code][phone number] eg. +441234512345. Please follow this link to know more : https://www.itu.int/rec/T-REC-E.123-200102-I/en |
S.No. | Attribute | Required | Type | Description |
1 | name | Yes | string | The name of the custom data field definition. This field is mandatory and cannot be empty. By default, maximum supported characters is 50. |
2 | value | Yes | string | The value of the custom data field code which needs to be associated with the user. This field is mandatory and cannot be empty. If the custom data field is of LIST type, the value provided must match with value on Egencia website. By default, maximum supported characters is 30 for LIST type and 50 for FREE_FIELD. |
S.No. | Attribute | Required | Type | Description |
1 | expirationDate | No | string | The expiration date of the document. (ISO 8601 date format YYYY-MM-DD) |
2 | issueCountry | No | string | The value of the document issue country. It should be 3 letters (alpha-3) or 2 letters (alpha-2) ISO country code of the document issuing country. Version 1 of the APIs support 3 letter country code while version 2 supports 2 letter country code |
3 | issueDate | No | string | The issuing date of the document. (ISO 8601 date format YYYY-MM-DD) |
4 | issueLocation | No | string | The name of the document issuing city. |
5 | type | Yes | string | The type code of the document e.g. passport, ID card, etc. Except China and Hong Kong, for rest of the countries we only support documents of type PAS, ID & DL. Please refer the Enumerations section for the values supported |
6 | value | Yes | string | The value of the document. This field is mandatory and cannot be empty. |
S.No. | Attribute | Required | Type | Description |
1 | approvers | No | AllApproversSchemaV2 | |
2 | arrangerGroups | No | Multi-Valued (string) | The arranger groups to which the user is associated with. The user must have an arranger role to get associated to an arranger group. |
3 | arrangers | No | Multi-Valued (ArrangerSchema) | Arrangers for the user. Arranger of a user must already exist and its unique id needs to be passed to associate that arranger with a user |
4 | companyId | No | string | Egencia website unique ID. The organization Id or company Id associated with the user. |
5 | customDataFields | No | Multi-Valued (CustomDataFieldSchema) | Egencia reporting fields. A complex attribute containing custom data fields associated with the user. |
6 | dateOfBirth | No | string | The date of birth of the user. (ISO 8601 date format YYYY-MM-DD) |
7 | documents | No | Multi-Valued (DocumentSchema) | A complex attribute containing documents associated with the user. |
8 | loyaltyPrograms | No | Multi-Valued (LoyaltyProgramSchema) | A complex attribute containing details of loyalty programs associated with the user. |
9 | preferences | No | Multi-Valued (PreferenceSchema) | A complex attribute containing details of the user preferences. |
10 | serviceLevelIds | No | Multi-Valued (string) | The service level details of the user. |
11 | settings | No | UserSettingsSchema | |
12 | singleSignOnId | No | string | The single sign-on id of the user. It is the SSO ID used for authentication. It will be username handled by Auth if not provided. |
13 | userAuthenticationMode | No | string | The case sensitive Authentication mode of the user. Values supported are LOGIN or SSO. It is mandatory if the company is SSO_OR_LOGIN. |
S.No. | Attribute | Required | Type | Description |
1 | primary | No | boolean | Identifier flag to determine whether the address is primary or not. |
2 | type | Yes | string | Type of email. Ex. WORK. Please refer the Enumerations section for the values supported. |
3 | value | Yes | string | The value of the email address. It needs to be in a standard format and cannot be empty. |
S.No. | Attribute | Required | Type | Description |
1 | approvers | No | ApproverSchema | |
2 | arrangerGroups | No | Multi-Valued (string) | The arranger groups to which the user is associated with. The user must have an arranger role to get associated to an arranger group. |
3 | arrangers | No | Multi-Valued (ArrangerSchema) | Arrangers for the user. Arranger of a user must already exist and its unique id needs to be passed to associate that arranger with a user |
4 | customDataFields | No | Multi-Valued (CustomDataFieldSchema) | Egencia reporting fields. A complex attribute containing custom data fields associated with the user. |
5 | dateOfBirth | No | string | The date of birth of the user. (ISO 8601 date format YYYY-MM-DD) |
6 | documents | No | Multi-Valued (DocumentSchema) | A complex attribute containing documents associated with the user. |
7 | employeeNumber | No | string | The employee number of the requested user. This field is only supported for EU point of sale. |
8 | loyaltyPrograms | No | Multi-Valued (LoyaltyProgramSchema) | A complex attribute containing details of loyalty programs associated with the user. |
9 | organization | Yes | string | Egencia website unique ID. The organization Id or company Id associated with the user. This field is mandatory and cannot be empty. |
10 | preferences | No | Multi-Valued (PreferenceSchema) | A complex attribute containing details of the user preferences. |
11 | serviceLevelIds | No | Multi-Valued (string) | The service level details of the user. |
12 | settings | No | UserSettingsSchema | |
13 | singleSignOnId | No | string | The single sign-on id of the user. It is the SSO ID used for authentication. It will be username handled by Auth if not provided. |
14 | userAuthenticationMode | No | string | The case sensitive Authentication mode of the user. Values supported are LOGIN or SSO. It is mandatory if the company is SSO_OR_LOGIN. |
S.No. | Attribute | Required | Type | Description |
1 | employeeNumber | No | string | The employee number of the requested user. This field is only supported for EU point of sale. |
S.No. | Attribute | Required | Type | Description |
1 | No | string | ||
2 | family_name | No | string | |
3 | given_name | No | string | |
4 | organization_id | Yes | string | |
5 | single_sign_on_id | No | string | |
6 | user_name | No | string |
S.No. | Attribute | Required | Type | Description |
1 | display | No | string | The displayable value of the group. |
2 | value | Yes | string | Egencia Traveler Group - the value of the group to which the user is associated. This field is mandatory and cannot be empty and must match with value on Egencia website. |
S.No. | Attribute | Required | Type | Description |
1 | accreditive | No | boolean | |
2 | class | No | string | The cabin class to which the loyalty program applies to. e.g. FIRST, SECOND. (applicable to Rail only) |
3 | code | No | string | The loyalty program code associated with the membership program. |
4 | issuingSupplierCode | Yes | string | The name of the supplier issuing the loyalty program. This field is mandatory and cannot be empty. |
5 | lob | Yes | string | The line of business type to which loyalty program is associated e.g. AIR, CAR, HOTEL, RAIL. Please refer the Enumerations section for the values supported. |
6 | name | Yes | string | The name of the loyalty membership program. This field is mandatory and cannot be empty. |
7 | type | No | string | The type of loyalty program if any. Please refer the Enumerations section for the values supported. |
8 | validFrom | No | string | The date from which the loyalty program is valid. (ISO 8601 date format YYYY-MM-DD) |
9 | validTo | No | string | The date to which the loyalty program is valid. (ISO 8601 date format YYYY-MM-DD) |
10 | value | Yes | string | The value of the loyalty program or membership id. This field is mandatory and cannot be empty and value cannot be greater than 30 characters |
S.No. | Attribute | Required | Type | Description |
1 | created | No | string | The creation time metadata. |
2 | lastModified | No | string | The last modification time. |
3 | location | No | string | The location of the user resource accessible by URI. |
4 | version | No | string | The version of the resource. |
S.No. | Attribute | Required | Type | Description |
1 | familyName | Yes | string | The family or last name of the user. This field is mandatory and cannot be empty. Maximum supported characters is 40. |
2 | formatted | No | string | The formatted name of the user |
3 | givenName | Yes | string | The given or first name of the user. This field is mandatory and cannot be empty. Maximum supported characters is 40. |
4 | honorificPrefix | No | string | The honorific prefix(es) of the User, or title in most Western languages (e.g., "Ms". given the full name "Ms. Barbara Jane Jensen, III"). This field is mandatory except for companies located in US for which it's ignored. Please refer the Enumerations section for the values supported. You need to pass label in this field. This field is not supported in version 1 of user APIs. |
5 | middleName | No | string | The middle name of the user. Maximum supported characters is 40. |
S.No. | Attribute | Required | Type | Description |
1 | lob | Yes | string | The line of business type to which preference is associated e.g. AIR, CAR, HOTEL, RAIL. This field is mandatory and cannot be empty. Please refer the Enumerations section for the values supported. |
2 | mealType | No | string | The preferred meal type. (applicable to Air only) |
3 | preferredDepartureAirport | No | string | The IATA code of the preferred departure airport. (applicable to Air only) |
4 | seatDirection | No | string | The preferred seat direction e.g. Forward, Any, etc. (applicable to Rail only) |
5 | seatFreeOfCharge | No | string | The flag to specify if a seat free of charge is to be booked (applicable to Rail only). |
6 | seatRoom | No | string | The preferred seat room e.g. Upper, Lower, Any. (applicable to Rail only) |
7 | seatSolo | No | string | The flag to specify if a solo seat is preferred for first class (applicable to Rail only). |
8 | seatType | No | string | The preferred seat type e.g. Window, Aisle, etc. |
9 | smoking | No | string | The smoking room preference e.g. Smoking, Non-smoking, Any. (applicable to Hotel only). |
10 | specialRequest | No | string | Any special request. The value cannot be greater than 80 characters |
S.No. | Attribute | Required | Type | Description |
1 | display | No | string | The displayable value of the role. |
2 | primary | No | boolean | The flag to represent if a role is primary or not. |
3 | value | Yes | string | The value of the role associated with the user. Please refer the Enumerations section for the values supported. |
S.No. | Attribute | Required | Type | Description |
1 | op | No | string | |
2 | path | No | string | |
3 | value | No | object |
S.No. | Attribute | Required | Type | Description |
1 | Operations | Yes | Multi-Valued (ScimPatchOperationSchema) | List of scim patch operations. |
2 | meta | No | MetaSchema | |
3 | schemas | Yes | Multi-Valued (string) | The schema urns for the associated resource. |
S.No. | Attribute | Required | Type | Description |
1 | filter | Yes | FilterRequest | |
2 | meta | No | MetaSchema | |
3 | schemas | Yes | Multi-Valued (string) | The schema urns for the associated resource. |
S.No. | Attribute | Required | Type | Description |
1 | outOfPolicyPurchaseEmails | No | Multi-Valued (string) | Email ids of users to notify when a purchase is out of policy. |
2 | reservationEmail | No | string | The reservation email setting of user. Valid values are : {ALL, NONE_EXCEPT_MY_ETICKETS, NORMAL}. Default value is NORMAL. ALL is supported only for Travel Directors and Manage User roles. Please refer the Enumerations section for the values supported. |
S.No. | Attribute | Required | Type | Description |
1 | active | Yes | boolean | The status of the user's profile.Please provide 'true' for active user or 'false' inactive user. |
2 | addresses | No | Multi-Valued (AddressSchema) | The physical contact addresses associated with the user account. |
3 | displayName | Yes | string | The name of the user, suitable for display to end-users. |
4 | emails | Yes | Multi-Valued (EmailSchema) | The email addresses associated with the user account. |
5 | externalId | Yes | string | Is an identifier for the user resource as defined by the provisioning client. |
6 | groups | No | Multi-Valued (GroupSchema) | A list of traveller groups to which the user is associated. The user can be associated with only one traveller group at the moment. |
7 | id | Yes | string | Is an unique identifier for the user resource as defined by the service provider. |
8 | meta | No | MetaSchema | |
9 | name | Yes | NameSchema | |
10 | phoneNumbers | No | Multi-Valued (ContactSchema) | The phone numbers associated with the user account. Multiple types of phone numbers are supported. |
11 | preferredLanguage | No | string | The user's preferred language. This field is not supported for US point of sale. If preferredLanguage is not passed, the default language which is configured for that company is set here. The supported languages are {"es","da","de","el","en","fr","it","nl","pt","fi","dv","cs","et","lv","lt","hu","mt","pl","sk","sl","bg","ro","tr","zh","nb","sv"}. eg. en, sv, etc. |
12 | roles | No | Multi-Valued (RoleSchema) | A list of roles for the user that collectively represent who the user is, e.g. Self-booker, Approver, Arranger, Flexible Arranger etc. |
13 | schemas | Yes | Multi-Valued (string) | The schema urns for the associated resource. |
14 | title | No | string | The user's salutation or title. This field is mandatory except for companies located in US for which it's ignored. Please refer the Enumerations section for the values supported. |
15 | urn:ietf:params:scim:schemas:extension:enterprise:2.0:User | Yes | EnterpriseUserSchema | |
16 | userName | No | string | A service provider's unique identifier for the user, typically used by the user to directly authenticate to the service provider. The value must be an email value with valid @ domain. Maximum supported characters is 60. |
17 | userType | Yes | string | The user's type. This field is mandatory. Please refer the Enumerations section for the values supported. |
S.No. | Attribute | Required | Type | Description |
1 | active | Yes | boolean | The status of the user's profile.Please provide 'true' for active user or 'false' inactive user. |
2 | addresses | No | Multi-Valued (AddressSchema) | The physical contact addresses associated with the user account. |
3 | emails | Yes | Multi-Valued (EmailSchema) | The email addresses associated with the user account. |
4 | externalId | Yes | string | Is an identifier for the user resource as defined by the provisioning client. |
5 | groups | No | Multi-Valued (GroupSchema) | A list of traveller groups to which the user is associated. The user can be associated with only one traveller group at the moment. |
6 | id | Yes | string | Is an unique identifier for the user resource as defined by the service provider. |
7 | meta | No | MetaSchema | |
8 | name | Yes | NameSchema | |
9 | phoneNumbers | No | Multi-Valued (ContactSchema) | The phone numbers associated with the user account. Multiple types of phone numbers are supported. |
10 | preferredLanguage | No | string | The user's preferred language. This field is not supported for US point of sale. If preferredLanguage is not passed, the default language which is configured for that company is set here. The supported languages are {"es","da","de","el","en","fr","it","nl","pt","fi","dv","cs","et","lv","lt","hu","mt","pl","sk","sl","bg","ro","tr","zh","nb","sv"}. For Canada point of sale, supported languages are CA_fr and CA_en only. |
11 | roles | No | Multi-Valued (string) | A list of roles for the user that collectively represent who the user is, e.g. SELF_BOOKER, APPROVER, ARRANGER, FLEXIBLE_ARRANGER, MANAGE_USERS, GUEST_MANAGER, etc. |
12 | schemas | Yes | Multi-Valued (string) | The schema urns for the associated resource. |
13 | urn:ietf:params:scim:schemas:extension:egencia:2.0:User | No | EgenciaExtensionUserSchemaV2 | |
14 | urn:ietf:params:scim:schemas:extension:enterprise:2.0:User | No | EnterpriseUserSchemaV2 | |
15 | userName | No | string | A service provider's unique identifier for the user, typically used by the user to directly authenticate to the service provider. The value must be an email value with valid @ domain. Maximum supported characters is 60. |
16 | userType | Yes | string | The user's type. This field is mandatory. Please refer the Enumerations section for the values supported. |
S.No. | Attribute | Required | Type | Description |
1 | notifications | No | UserNotificationsSchema |
Version | What has changed? |
---|---|
1.0 | First stable version. |