此API已被弃用。

弃用日期:04/01/2016

使用已弃用API的合作伙伴和客户应该联系SAP Concur,并讨论如何转移到最新版本。

了解更多内容API生命周期和弃用策略。

当前版本:旅行简介V2.

描述

Travel Profile资源表示Concur Travel Profile,其中包含有关用户的旅行关系信息,例如:

  • 身份
  • 联系信息
  • 利率偏好和折扣代码
  • 旅行类型的偏好

URI

https:// {instanceurl} /api/travelprofile/v1.0/profile

运营

获取旅行简介

获取指定用户的旅行资料信息。旅行简档包括诸如用户身份,联系信息,速率优先级和折扣代码,旅行类型和自定义字段之类的信息。此获取操作返回的旅行简档信息取决于呼叫者是旅行供应商,TMC还是主流开发人员:

  • 旅游供应商只能获得其自身忠诚度和折扣计划的忠诚度计划信息和折扣代码。
  • tmc可以获得指定用户的所有忠诚计划和折扣代码。
  • 主流开发人员无法获得任何忠诚度计划或折扣信息。

请求参数

所有请求参数都是可选的。要通过登录ID或XMLSyncid来标识特定用户,可以指定以下请求参数:

参数名称 参数类型 数据类型 描述
userid_type 路径 字符串 使用的用户识别类型。可能的值是:登录xmlsyncid
userid_value 路径 字符串 用户的登录ID或XMLSync ID,取决于选择的用户类型。此参数必须与userid_type范围。

内容类型的头

应用程序/xml

认证头

授权:OAuth {access_token}

在哪里Access_Token.OAuth 2.0访问您要检索的旅行配置文件信息的用户的令牌。如果希望访问公司范围内的旅行配置文件信息,与OAuth 2.0访问令牌相关联的用户帐户必须具有以下角色之一的Concur帐户:专业Web服务管理员或标准Web服务管理员。

数据模型

GET操作响应的数据模型。

状态=“积极|活动”独特=“{用户唯一标识符}”>/>< FirstName/>/>/>< NameSuffix/>< PreferredName/>/><首选语言/>< EReceiptOptIn/>/>/>/>/>一般> < /<电话><电话类型=“细胞|其他|寻呼机|传真|主页|工作|主要手机”>/>/>< PhoneNumber/><扩展/>> < /电话<地址><地址类型=“家庭|工作|账单|其他”>< AttentionLine/>< Line1/><么/>< Line3/>< MailStop/><市/>< StateProvince/>/>/>< Laditude/><经度/>< DriversLicense >/><发行国/>/><到期/>< / DriversLicenses >< emailaddress >/>< RatePreferences >< AAARate/>阿尔普拉特/>/>军事化/>< / RatePreferences ><折扣码>< DiscountCode/><空>< AirSmokingCode/>< VendorCode/>/><状态/>/>/>/>/>/>/><上>/>/><饭菜>< MealCode/>/>< AirOther/>< DHSRedressNumber/>/>/>< CarGPS/>/>/>< VendorCode/>/><状态/>/>/>/>/>/>/>/>< CarSkiRack/>汽车> < //>/><将/>/>泡沫塑料枕头/>/><更喜欢滚床/>< preferGym/>< preferPool/>< preferRestaurant/>/><更喜欢盲人/><客房服务/>< preferEarlyCheckIn/>> < /酒店< CustomFields >/><价值/>< / CustomField >

ProfileResponse根元素

ProfileResponse根元素包含General、phones、Addresses、DriversLicenses、EmailAddresses、RatePreferences、DiscountCodes、Air、Car、Hotel和CustomFields子元素。它具有数据模型部分中显示的属性。

一般要素

父元素General包含以下子元素:

元素名称 数据类型 描述
NamePrefix 字符串 用户名前缀。格式:Varchar (60)
FirstName 字符串 用户的名字。格式:Varchar (32)
中间名 字符串 用户的中间名。格式:Varchar (32)
姓氏 字符串 用户的姓。格式:Varchar (32)
NameSuffix 字符串 用户的名称后缀。格式:Varchar (60)
首选名称 字符串 用户的首选名称。格式:Varchar (60)
职称 字符串 用户的职务。格式:Nvarchar(255)
PreferredLanguage 字符串 用户的首选语言环境。例如:United English为en-US。格式:Varchar (20)
EreeceipTin. 字符串 用户是否已选择接收电子收据。格式:真/假
MarketingOptin. 字符串 用户是否选择接收营销信息。格式:真/假
HasOpenBooking 布尔基 是否具有TripLink user(原Open Booking user)权限。格式:真/假
CountryCode 字符串 国家代码从ISO 3166-1 Alpha-2国家代码规范。格式:字符(2)
公司名称 字符串 用户的公司名称。

电话元件

电话机的父元素包含每个电话机的Telephone子元素。电话元素具有响应类部分中显示的属性,并包含以下子元素:

元素名称 数据类型 描述
ContactOptIn 字符串 用户是否选择在这个电话上被联系。仅当手机类型为“手机”或“主用手机”时显示。格式:真/假
CountryCode 字符串 国家代码从ISO 3166-1 Alpha-2国家代码规范。格式:字符(2)
PhoneNumber 字符串 用户输入的电话号码,它可能包含()或 - 。格式:char(60)
:如果有数据输入问题,用户电话号码有时可能会错误地解析。
延伸 字符串 电话扩展。格式:Varchar (60)

解决元素

地址父元素包含每个包含地址的地址子元素。地址元素具有响应类部分中显示的属性,并包含以下子元素:

: Address子元素的返回值与用户输入的值一致。字段不强制格式化,可能有各种各样的值。

元素名称 数据类型 描述
注意线 字符串 注意力线在地址中。格式:Nvarchar(无限)
LINE1. 字符串 地址行1.格式:nvarchar(无限制)
LINE2. 字符串 地址行2。格式:Nvarchar(无限)
线3. 字符串 地址线3。格式:Nvarchar(无限)
MailStop 字符串 地址:邮箱。格式:Nvarchar(无限制)
城市 字符串 这个城市的名字。格式:Nvarchar(无限)
StateProvince 字符串 州或省。格式:Nvarchar(无限)
CountryCode 字符串 国家代码从ISO 3166-1 Alpha-2国家代码规范。格式:字符(2)
邮政编码 字符串 邮政编码。格式:Varchar (20)
经度 字符串 工作地址的经度值。
纬度 字符串 工作地址的纬度值。

驾驶员元素

父元素DriversLicenses为每个包含的许可证包含一个DriversLicense子元素。DriversLicense元素包含以下子元素:

元素名称 数据类型 描述
DriversLicenseNumber 字符串 用户的驾驶执照识别号码。格式:Varchar (30)
IssuingCountry 字符串 许可证的牌照已发布。格式:char(2)
IssuingState 字符串 执照签发的州。格式:Varchar (2)
到期 字符串 license的截止日期。格式:YYYY-MM-DD

EmailAddresses元素

父元素EmailAddresses为每个包含的电子邮件地址包含一个EmailAddress子元素。它包含以下子元素:

元素名称 数据类型 描述
EmailAddress 字符串 用户的电子邮件地址。EmailAddress元素有两个属性:类型和联系人。type属性指定电子邮件地址的类型和可能的值是:商业Business2个人的.Contact属性指定电子邮件地址是否应用于旅行通知,并且可能的值是真正的.格式:Varchar (255)

RatePreferences元素

Ratepreferences父元素包含以下子元素:

元素名称 数据类型 描述
AAARate 布尔基 用户是否有资格享受AAA费率。格式:真/假
aarprate. 布尔基 用户是否有资格获得AARP率。格式:真/假
GovtRate 布尔基 用户是否有资格享受政府费率。格式:真/假
军事劳工 布尔基 用户是否有资格获得军事利率。格式:真/假

discountcode元素

折扣代码父元素包含每个包含的折扣代码的折扣代码子元素。

元素名称 数据类型 描述
DiscountCode 字符串 指定供应商的折扣代码。这DiscountCodeelement has a Vendor attribute that specifies the name of the vendor for the discount code.

空气元素

航空父元素包含用户的航空旅行首选项,并包含以下子元素:

元素名称 数据类型 描述
空气吸烟代码 字符串 用户是否想要允许吸烟的航班。遗产。格式:年代ND
空调 会员 只有当请求来自该旅行类型的旅行供应商或TMC时,才会出现AirMemberships元素。此元素包含每个成员的AirMembership子元素,并包含以下子元素:
座位 - 此父元素包含用户的汽车旅行偏好。这汽车元素包含以下子元素:
- 此父元素包含EnalCode子元素,表示旅行者的膳食偏好。可能的值是:
AVML=印度素食餐
bbml =婴儿用餐
BLML = BLAND膳食
chml =儿童用餐
dbml =糖尿病粉
水果拼盘
GFML=不耐麸质膳食
HNML =印度教
KSML =犹太餐
LCML =低卡路里的饭菜
LFML =低脂膳食
lsml =低盐粉
MOML =穆斯林餐
低乳糖粉
nsml =没有盐粉
PFML =无花生餐
SFML =海鲜餐
SPML =特殊要求餐
VGML =素食
素食生素食
素食奶蛋
素食耆那教套餐
VOML =东方素食餐

笔记:常规膳食不会返回此首选项的值。
家庭机场 字符串 用户的家庭机场
DHSRedressNumber 字符串 TSA赔偿数量
Dhsknowntravelernumber 字符串 TSA已知旅客号码
空运 字符串 其他与空气有关的说明
航空公司会员元素
元素名称 数据类型 描述
卖方代码 字符串 管理忠诚度计划的供应商代码。
AccountNo 字符串 忠诚度计划中用户的帐户标识符。
状态 字符串 用户在忠诚度计划中的当前级别的名称。
statusbenefits. 字符串 描述当前状态下忠诚计划的好处。
pointtotal. 字符串 用户在忠诚度计划中的总点数。
分段总计 字符串 用户在忠诚度计划中的总细分。
nextstatus. 字符串 忠诚度计划中的下一个更高状态级别的名称或描述。
点直到下一个状态 字符串 下一个状态级别所需的忠诚度点数。
分节状态 字符串 预订下一个地位级别。
座位的元素
元素名称 数据类型 描述
行间位置码 字符串 飞机排中的首选位置。格式:窗户走道中间孤立的唐卡
部分位置代码 字符串 优先选择平面位置。格式:FBRD

汽车元素

Car父元素包含用户的汽车出行首选项。它包含以下子元素:

元素名称 数据类型 描述
carsmokingcode. 字符串 吸烟车厢优先。格式:年代NO
汽车GPS 字符串 汽车GPS优先。格式:真/假。
CarOption 字符串 汽车期权偏好。格式:char(3)
花匠 会员 CarMemberships元素只有在请求来自该旅行类型的旅行供应商或TMC时才会出现。这个元素包含每个成员的CarMembership子元素。CarMembership元素有以下子元素:
CarOther 字符串 其他汽车相关描述。格式:char(30)
Carskirack. 字符串 汽车滑雪架偏好。格式:true / false。
汽车会员资格要素
元素名称 数据类型 描述
卖方代码 字符串 管理忠诚度计划的供应商代码。
AccountNo 字符串 忠诚度计划中用户的帐户标识符。
状态 字符串 用户在忠诚度计划中的当前级别的名称。
statusbenefits. 字符串 描述当前状态下忠诚计划的好处。
pointtotal. 字符串 用户在忠诚度计划中的总点数。
分段总计 字符串 用户在忠诚度计划中的总细分。
nextstatus. 字符串 忠诚度计划中的下一个更高状态级别的名称或描述。
点直到下一个状态 字符串 下一个状态级别所需的忠诚度点数。
分节状态 字符串 预订下一个地位级别。

酒店的元素

酒店父元素包含用户的旅行偏好。它包含以下子元素:

元素名称 数据类型 描述
SmokingCode 字符串 吸烟室的偏好。格式:年代ND
HotelMembership. - 只有当该请求来自此旅行类型的旅行供应商或TMC时,才会出现此父元素。此元素包含每个包含会员资格的HotelMembership子元素。HotelMembership元素具有以下儿童元素:
房型 字符串 酒店房间的偏好。取值为:H, 2, K, Q, 1, T
HotelOther 字符串 其他酒店相关说明。格式:Varchar(30)
我喜欢泡沫枕头 字符串 用户是否喜欢泡沫枕头。格式:true / false。
优先范围 字符串 用户是否喜欢婴儿床。格式:真/假。
喜欢溜冰 字符串 使用者是否喜欢使用可移动床。格式:真/假。
首选健身房 字符串 用户是否喜欢和健身房的酒店。格式:真/假。
首选池 字符串 用户是否喜欢有游泳池的酒店。格式:真/假。
优先考虑 字符串 用户是否更喜欢有餐厅的酒店。格式:真/假。
preferWheelchairAccess 字符串 用户是否需要轮椅访问。格式:true / false。
更喜欢侵入的 字符串 用户是否需要一个可以访问盲人客人的房间。格式:真/假。
偏爱娱乐服务 字符串 用户是否更喜欢客房服务。格式:真/假。
优先考虑 字符串 用户是否更喜欢早期检查的酒店。格式:真/假。
酒店会员资格要素
元素名称 数据类型 描述
卖方代码 字符串 管理忠诚度计划的供应商代码。
AccountNo 字符串 忠诚度计划中用户的帐户标识符。
状态 字符串 用户在忠诚度计划中的当前级别的名称。
statusbenefits. 字符串 描述当前状态下忠诚计划的好处。
pointtotal. 字符串 用户在忠诚度计划中的总点数。
分段总计 字符串 用户在忠诚度计划中的总细分。
nextstatus. 字符串 忠诚度计划中的下一个更高状态级别的名称或描述。
点直到下一个状态 字符串 下一个状态级别所需的忠诚度点数。
分节状态 字符串 预订下一个地位级别。

自定义字段元素

Customfields父元素包含子元素,可在旅行配置文件中指定自定义字段。它包含每个自定义字段的自定义字段子元素。检索此信息,旅行概况自定义字段必须在其中选择范围注册合作伙伴申请翻页Web服务

customfield子元素

对于每个自定义字段,Customfield元素具有名称和值子元素。

元素名称 数据类型 描述
名称 字符串 自定义字段的名称。例如,员工,成本中心,基金,护照,签证和助理。
价值 字符串 自定义字段的值。如果值为null,则忽略value子元素。

旅游供应商的例子

示例1:获取与指定的OAuth 2.0访问令牌关联的用户的旅行型材

要求
得到InstanceURI/api/travelprofile/v1.0/profile HTTP/1.1访问令牌
回应
HTTP/1.1 200 OK内容类型:application/xml
状态=“活动”独特=“CM12345678”>/>玛丽亚< / FirstName >< MiddleName >X黑色的< / LastName >< NameSuffix/>< PreferredName/>财务经理<首选语言>念头美国真正的< MarketingOptIn >真正的< HasOpenBooking >真正的我们<公司名称>ExampleDotCom一般> < /<电话><电话类型=“工作”>0015555551234.< / PhoneNumber ><扩展/>> < /电话<电话类型=“细胞”>0014155544321< / PhoneNumber ><扩展/>真正的> < /电话<地址><地址类型=“工作”><注意力>财务部门< / AttentionLine >< Line1 >下雨的街1234号。<么>套房442.< Line3/>< MailStop/><市>西雅图我们98102< / ZipCode ><经度>-77.040706000000<纬度>38.812690000000<地址类型=“家”>< AttentionLine/>< Line1 >南第一大道1234号<么>易于。821.< Line3/>< MailStop/><市>西雅图我们98102< / ZipCode ><经度>-77.040706000000<纬度>38.812690000000< DriversLicense >MIL112233452< / DriversLicenseNumber >< IssuingCountry >我们< IssuingState ><过期>2018-05-22< / >到期< / DriversLicenses >< emailaddress >类型=“商业”联系=“对”>mariab@example.com..< RatePreferences >真正的< / AAARate ><军事费率>< / MilitaryRate >< / RatePreferences ><折扣码>< DiscountCodevendor =“万豪”>12345.67899.<空>< AirSmokingCode >年代AAK12345.< >状态普通的< StatusBenefits >N/ A.< / StatusBenefits >12342< / SegmentTotal >极好的< / NextStatus >444.2<上>< InterRowPositionCode >窗户< / InterRowPositionCode >F< / SectionPositionCode ><饭菜>VGML..< / MealCode >< / HomeAirport >< AirOther/>N< / CarSmokingCode >真正的< / CarGPS >/>< CarMemberships >ABCDEF< >状态新手< StatusBenefits >10%的折扣< / StatusBenefits >448< / SegmentTotal >老兵< / NextStatus >5512XW.吉克< >状态金子< StatusBenefits >30%的折扣< / StatusBenefits >100050< / SegmentTotal >贵宾< / NextStatus >50025< / CarMemberships >/>< / CarSkiRack >汽车> < /< SmokingCode >N/>K/>真正的< / PreferFoamPillows >真正的< PreferGym >真正的< / PreferGym >真正的真正的< / preferRestaraunt >< preferWheelchairAccess >< / preferWheelchairAccess >真正的< preferEarlyCheckIn >< / preferEarlyCheckIn >> < /酒店< CustomFields >员工ID< /名称>12345.< /值>< / CustomField >成本中心< /名称>总部< /值>< / CustomField >基金< /名称>学生培训< /值>< / CustomField >护照号码&燃气轮机;< /名称>Aus1234.< /值>< / CustomField >签证< /名称>EUvisa1234< /值>< / CustomField >助理< /名称>约翰·史密斯< /值>< / CustomField >

示例2:获取具有特定登录ID的用户的旅行配置文件

要求
得到https://www.concursolutions.com/api/travelprofile/v1.0/profile?userid_type登录&userid_valuecm@example.com http / 1.1授权:OAuth访问令牌
回应

响应与实施例1中的相同。

TMCS的例子

示例3:获取与指定的OAuth 2.0访问令牌关联的用户的旅行配置文件

要求
得到InstanceURI/api/travelprofile/v1.0/profile HTTP/1.1访问令牌
回应
HTTP/1.1 200 OK内容类型:application/xml
状态=“活动”独特=“CM12345678”>/>玛丽亚< / FirstName >< MiddleName >X黑色的< / LastName >< NameSuffix/>< PreferredName/>财务经理<首选语言>念头美国真正的< MarketingOptIn >真正的< HasOpenBooking >真正的我们<公司名称>ExampleDotCom一般> < /<电话><电话类型=“工作”>0015555551234.< / PhoneNumber ><扩展/>> < /电话<电话类型=“细胞”>0014155544321< / PhoneNumber ><扩展/>真正的> < /电话<地址><地址类型=“工作”><注意力>财务部门< / AttentionLine >< Line1 >下雨的街1234号。<么>套房442.< Line3/>< MailStop/><市>西雅图我们98102< / ZipCode ><经度>-77.040706000000<纬度>38.812690000000<地址类型=“家”>< AttentionLine/>< Line1 >南第一大道1234号<么>易于。821.< Line3/>< MailStop/><市>西雅图我们98102< / ZipCode ><经度>-77.040706000000<纬度>38.812690000000< DriversLicense >MIL112233452< / DriversLicenseNumber >< IssuingCountry >我们< IssuingState ><过期>2018-05-22< / >到期< / DriversLicenses >< emailaddress >类型=“商业”联系=“对”>mariab@example.com..< RatePreferences >真正的< / AAARate ><军事费率>< / MilitaryRate >< / RatePreferences ><折扣码>< DiscountCodevendor =“万豪”>12345.67899.< DiscountCodevendor =“IHG”>111222333</折扣< / span ><空>< AirSmokingCode >年代AAK12345.< >状态普通的< StatusBenefits >N/ A.< / StatusBenefits >12342< / SegmentTotal >极好的< / NextStatus >444.2<上>< InterRowPositionCode >窗户< / InterRowPositionCode >Nopref.< / SectionPositionCode ><饭菜>VGML..< / MealCode >< / HomeAirport >< AirOther/>N< / CarSmokingCode >真正的< / CarGPS >/>< CarMemberships >ABCDEF< >状态新手< StatusBenefits >10%的折扣< / StatusBenefits >448< / SegmentTotal >老兵< / NextStatus >5512XW.吉克< >状态金子< StatusBenefits >30%的折扣< / StatusBenefits >100050< / SegmentTotal >贵宾< / NextStatus >50025< / CarMemberships >/>< / CarSkiRack >汽车> < /< SmokingCode >N/>K/>真正的< / PreferFoamPillows >真正的< PreferGym >真正的< / PreferGym >真正的真正的< / preferRestaraunt >< preferWheelchairAccess >< / preferWheelchairAccess >真正的< preferEarlyCheckIn >< / preferEarlyCheckIn >> < /酒店< CustomFields >员工ID< /名称>12345.< /值>< / CustomField >成本中心< /名称>总部< /值>< / CustomField >基金< /名称>学生培训< /值>< / CustomField >护照号码&燃气轮机;< /名称>Aus1234.< /值>< / CustomField >签证< /名称>EUvisa1234< /值>< / CustomField >助理< /名称>约翰·史密斯< /值>< / CustomField >

示例4:获取具有特定登录ID的用户的旅行配置文件

要求
得到https://www.concursolutions.com/api/travelprofile/v1.0/profile?userid_type登录&userid_valuecm@example.com http / 1.1授权:OAuth访问令牌
回应

响应与实施例3中的响应相同。

获取旅行简介摘要列表

获取自指定日期以来已更新的旅行配置文件摘要列表。响应被分成多个页面。

要求

得到InstanceURI/ api / travelprofile / v1.0 /配置文件?LastModifiedDate.2015-01-01T01:00:00 HTTP / 1.1授权:OAuth访问令牌

请求参数

所有请求参数都是可选的。要通过登录ID或XMLSyncID识别特定用户,可以指定以下请求参数。

参数名称 必填/可选 参数类型 数据类型 描述
LastModifiedDate. 必需的 小路 细绳 UTC中的日期和时间必须在响应中包含在响应之后更新。格式:YYYY-MM-DDTHH:MM:SS
可选 小路 细绳 要检索的页数。如果页面超出了现有页面的数量,则响应元素将为空
ItemsPerPage 可选 小路 细绳 每页的旅行简介数。最大值为200.默认值为200。

同意头部

应用程序/xml

认证头

授权:OAuth {access_token}

在哪里Access_Token.是您想要检索其旅行概要摘要的用户的OAuth 2.0访问令牌。如果希望访问公司范围内的旅行配置文件信息,与OAuth 2.0访问令牌相关联的用户帐户必须具有以下角色之一的Concur帐户:专业Web服务管理员或标准Web服务管理员。

数据模型

GET操作响应的数据模型。

<元数据>/>< TotalItems/>/>< ItemsPerPage/>/>/><数据>< LoginID/>/>/>

回应

ConnectResponse根元素

ConnectResponse根元素包含General、phones、Addresses、DriversLicenses、EmailAddresses、RatePreferences、DiscountCodes、Air、Car、Hotel和CustomFields子元素。它具有响应类部分中显示的属性。

元数据元素

Metadata父元素包含Paging子元素。

分页元素

分页父元素包含包含响应的分页信息,它包含以下子元素:

元素名称 数据类型 描述
TotalPages 字符串 要返回的总页数。
TotalItems 字符串 查询返回的概要文件的总数。
字符串 当前响应中结果集的页码。
ItemsPerPage 字符串 设置为每页显示的项目数。
prevararpageurl. 字符串 结果的URI结果。没有先前页面时,此元素将为空。
nextPageurl. 字符串 下一组结果的URI。当没有下一页页面时,此元素将为空。

数据元素

Data父元素包含每个包含的旅行配置文件的ProfileSummary子元素。

ProfileSummary

分页父元素包含包含响应的分页信息,它包含以下子元素:

元素名称 数据类型 描述
LoginID 字符串 Concur用户登录ID。
XMLProfileSyncID 字符串 如果可用,则用户的XML配置文件同步ID
profilelastmodifiedutc. 字符串 上次修改旅行配置文件的日期(UTC)。格式:YYYY-MM-DDThh:MM:ss。

例子

此示例获取2015年1月1日之后修改的旅行简介摘要列表。

要求

得到InstanceURI/ api / travelprofile / v1.0 /配置文件?LastModifiedDate.2015-01-01T01:00:00 HTTP / 1.1授权:OAuth访问令牌

回应

HTTP/1.1 200 OK内容类型:application/xml
<元数据>< TotalPages >1< / TotalPages >2< >页1> < /页< ItemsPerPage >200.< / ItemsPerPage >/>/><数据>mariab@company1.com< / LoginID >< XmlProfileSyncID >字符串1232015 - 01 - 01 - t01:00:00peterk@company1.com< / LoginID >< XmlProfileSyncID >细绳4562015 - 01 - 01 - t01:00:00