This endpoint provides travel profile information for the specified user. The travel profile includes information such as the user’s identity, contact information, rate preferences and discount codes, preferences by travel type, and custom fields.

URI

https://{InstanceURL}/api/travelprofile/v2.0/profile

Request parameters

All request parameters are optional. To identify a specific user by Login ID or XML Sync ID, you can specify the following request parameters:

Parameter Name

Parameter Type

Data Type

Description

userid_type

Path

string

The type of user identification to use. Possible values are: login and xmlsyncid

userid_value

Path

string

The user’s Login ID or XML Sync ID, depending on which user type is selected. This parameter must be provided in conjunction with the userid_type parameter.

Headers

Content-Type header

application/xml

Authorization header

Authorization: OAuth {access_token}

Where access_token is the OAuth 2.0 access token of the user whose travel profile information you want to retrieve.

Authorization header

Data model

The complete schema definition is available here: Travel Profile XSD.
SAP Concur reserves the right to change the XSD. Reading/writing strictly to the XSD will result in breakage as new XML elements are added.

NOTE: If MiddleName is provided, the NoMiddleName flag in TSAInfo section is set to false.

EmergencyContact elements

The emergency contact information provided.

Emergency Contact Information scope must be enabled to receive the data.

Element Name

Data Type

Description

Update

Create

Comments

Name

string

The emergency contact name Format: nvarchar(255)

Relationship

string

The relationship to the user. Values are: Spouse, Brother, Parent, Sister, LifePartner, Other

Phone

list

If multiple values of the same telephone type are provided, only the last one will be saved. See below for the list elements.

Address

Address

Street Address. Format: nvarchar(max)

Address Elements

Element Name

Data Type

Description

Update

Create

Comments

Street

string

Street Address. Format: nvarchar(max)

City

string

The city name. Format: nvarchar(30)

StateProvince

string

The state or province. Format: nvarchar(30)

CountryCode

string

The country code in from the ISO 3166-1 alpha-2 country code specification. Format: char(2)

PostalCode

string

The postal code. Format: nvarchar(20)

Phone List Elements

Element Name

Data Type

Description

Update

Create

Comments

PhoneNumber

string

The emergency contact’s phone number. Format: nvarchar(60)

No unicode characters.

Type

string

This contains a “type” attribute with values of DayTime or Alternate.

Required

Required

Telephones elements

The Telephones parent element contains a Telephone child element for each included telephone. The Telephone element has the attributes shown in the Response Class section and contains the following child elements:

Element Name

Data Type

Description

Update

Create

Comments

Type attribute

string

Type of phone. Values are: Home, Work, Fax, Pager, Other, and Cell

required

required

ContactOptIn attribute

boolean

Whether the user has opted in to being contacted on this phone. Only appears when the phone type is Cell. Format: true|false

Only Work (NOT Work2) uses Extension
* Only a single number can be kept for each of these types. If more than one of each type is provided, W016 warning message is returned.

Multiple cell phones can be updated, but will sync to the list provided. Cell phones missing from that list that currently associate with the user will be deleted.

PrimaryMobile:

If there is not exactly 1 PrimaryMobile specified in changing cell phones, then all cell phone changes will be rejected. If only 1 Cell Phone is provided, it is marked as Primary.

Addresses elements

The Addresses parent element contains an Address child element for each included address. The Address element has the attributes shown in the Response Class section and contains the following child elements:

NOTE: The values returned for the Address child elements are as entered by the user. The fields do not enforce formatting and may have a wide variety of values.

Element Name

Data Type

Description

Update

Create

Comments

Type attribute

string

Address type. Values are: Home or Work

required

required

If multiple values are provided for either address type, the last one will be the one saved in the creation/update.

Request

Request parameters

All request paramenters are optional. Available request parameters are as follows:

Parameter Name

Required/Optional

Parameter Type

Data Type

Description

LastModifiedDate

Required

path

string

The date and time, in UTC, that the profiles must be updated after to be included in the response. Format: YYYY-MM-DDThh:mm:ss

Page

Optional

path

string

The number of pages to retrieve. If the page is outside the number of existing pages, the response elements will be empty

ItemsPerPage

Optional

path

string

The number of travel profiles per page. The maximum value is 200. The default value is 200.

Headers

Accept header

application/xml

Authorization header

Authorization: OAuth {access_token}

Where access_token is the OAuth 2.0 access token of the user whose travel profile summaries you want to retrieve. If you want to access company-wide travel profile information, the user account associated with the OAuth 2.0 access token must have an SAP Concur account with one of these roles: Web Services Administrator for Professional or Can Administer for Standard.