User Information

Element

Data Type

Is Required

Description

Example

Username

string

Yes

Username for user

“testtraveler”

Title

string

No

User title

“MR”

FirstName

string

Yes

First name

“Test”

MiddleName

string

No

Middle name

“Test”

LastName

string

Yes

Last name

“Test”

EmailAddress

string

Yes

Email address

test@test.com

Gender

string

Yes

Gender
 Available values: Male, Female

“Male”

PhoneNumber

string

No

Phone number

6286574384

PhoneNumberCountryCode

string

No

Phone number country code.
 i.e. for US it is “1”

“1”

DateOfBirth

DateTime

Yes

Date of birth

Date time format: yyyy-MM-dd

1994-05-26

Password

string

Yes

Passowrd

“Password123!”

DriversLicence

string

No

Driver license

“315DKA95”

PersonalPhoneNumberCountryCode

string

No

Personal phone number county code

i.e. for US it is “1”

1

PersonalPhoneNumber

string

No

Personal phone number

“65498413865”

MealPreference

string

No

Preferred meal

“BBML”

PersonalAddress

string

No

Personal address

“Some address 132”

BusinessAddress

string

No

Business address

“Some address 133”

EmergencyContact
 Name

string

No

Emergency Contact Name

“Person”

EmergencyContact
 Phone

string

No

Emergency Contact Phone

“48645321869”

EmergencyContact
 Email

string

No

Emergency Contact Email

“emergency@mail.com”

JobTitle

string

No

Job title

“DEV”

Department

string

No

Department

“Department no. 3”

Project

string

No

Project

“Project no. 5”

Devision

string

No

Division

“Some division”

KnownTravellerId

string

No

Unique identification number assigned to individuals who have completed certain security screenings and background checks through the TSA PreCheck program

“HFJYYS1141”

ThirdPartySyncExternalId

string

No

Third party unique identifier

“16854651”

EmployeeId

string

No

Internal identifier for employee

“321654984”

RedressNumber

string

No

Unique identification number assigned to individuals who have been cleared through the TSA’s Secure Flight program

“HKKKS21”

GDSRecordLocator

string

No

GDS record locator. Used for sync profile with GDS

“1561864653”

DefaultDepartureIataCode

string

No

Default departure iata code.
 That iata code will preselected on search form

“MIA”

Passports

Passport[]

No

An array of passport information. You can have max two passports.

 

FrequentFlyerPrograms

FrequentFlyerProgram[]

No

An array of frequent flyer programs

 

HotelLoyaltyPrograms

HotelLoyaltyProgram[]

No

An array of hotel loyalty programs

 

CarLoyaltyPrograms

CarLoyaltyProgram[]

No

An array of car loyalty programs

 

UserRoles

UserRole[]

No

An array of roles assigned to user

 

UserCoordinators

UserCoordinator[]

No

An array of coordinators assigned to user

 

 

Passport

Element

Data Type

Is Required

Description

Example

PassportNumber

string

No

Passport number

“2116548948”

PassportIssueDate

DateTime

No

Passport issue date
 Date time format:

yyyy-MM-dd

2016-05-25

PassportExpireDate

DateTime

No

Passport expire date
 Date time format:

yyyy-MM-dd

2026-05-25

PassportIssueCountryCode

string

No

Two-character passport issue country code

“US”

PassportNationalityCountryCode

string

No

Two-character passport nationality country code

“US”

 

FrequentFlyerProgram

Element

Data Type

Is Required

Description

Example

AirlineCode

string

Yes

Two-character airline code

“AA”

FlyerProgramCode

string

Yes

Airline flyer program code

“DK78AD”

 

HotelLoyaltyProgram

Element

Data Type

Is Required

Description

Example

HotelChainCode

string

Yes

Unique hotel chain code

“HH”

LoyaltyNumber

string

Yes

Hotel loyalty number

“4688466”

 

CarLoyaltyProgram

Element

Data Type

Is Required

Description

Example

CarChainCode

string

Yes

Unique car chain code

“ZI”

LoyaltyNumber

string

Yes

Car loyalty number

“46511489”

 

UserRole

Element

Data Type

Is Required

Description

Example

Roles

string[]

Yes

An array of roles assigned to user for specific travel group
 Available roles: TravelGroupAdmin, Coordinator, Approver, AlternativeApprover, Traveler, ReportAdmin, ProfileManager

[“TravelGroupAdmin”, “Traveler”, “Coordinator”]

TravelGroupCode

string

Yes

Unique code of travel group in which user will have provider roles

AGPDD

IsDefaultTravelGroup

bool

Yes

Defines in which travel group will user be logged in.

true

 

UserCoordinator

Element

Data Type

Is Required

Description

Example

Coordinators

string[]

Yes

An array of coordinators username.
 Note: all coordinators need to have that role

[“coordinator1”,
 “coordinator2”]

TravelGroupCode

string

Yes

Unique code of travel group of provided coordinators

AGPDD