旅行配置文件资源表示一个Concur旅行配置文件,其中包含关于用户的旅行相关信息。
每个HTTP方法的文档中都有请求和响应的详细描述。
此端点为指定的用户提供旅行配置文件信息。旅行配置文件包括用户身份、联系信息、价格首选项和折扣代码、按旅行类型划分的首选项和自定义字段等信息。
https://{InstanceURL}/api/travelprofile/v2.0/profile
所有请求参数都是可选的。要通过登录ID或XML同步ID识别特定用户,可以指定以下请求参数:
参数名称 | 参数类型 | 数据类型 | 描述 |
---|---|---|---|
userid_type |
路径 |
字符串 |
要使用的用户标识的类型。可能的值是:登录 和xmlsyncid |
userid_value |
路径 |
字符串 |
用户的登录ID或XML同步ID,这取决于选择的用户类型。此参数必须与userid_type 参数。 |
应用程序/xml
授权:OAuth {access_token}
其中access_token是您希望检索其旅行配置文件信息的用户的OAuth 2.0访问令牌。
创建/更新概要文件使用与检索内容相同的模型。
FirstName
姓
TravelConfigID
(用于验证机构和公司访问创建用户)LoginID
密码
(如果没有提供,我们将设置一个随机的强密码)RuleClass
(如果没有提供,则使用默认规则类)应用程序/xml
授权:OAuth {access_token}
在哪里access_token
是您希望检索或更新其旅行配置文件信息的用户的OAuth 2.0访问令牌。
完整的模式定义在这里:旅游形象XSD.
SAP Concur保留更改XSD的权利。严格地对XSD进行读写将导致在添加新的XML元素时出现破坏。
Profile根元素包含:
的名字 | 数据类型 | 描述 | 更新 | 创建 | 评论 |
---|---|---|---|---|---|
NamePrefix |
字符串 |
用户名前缀。格式:nvarchar (60) | - | - | - |
FirstName |
字符串 |
用户的名字。格式:nvarchar (60) | - | 要求 | - |
中间名 |
字符串 |
用户的中间名。格式:nvarchar (60) | - | - | - |
姓 |
字符串 |
用户的姓。格式:nvarchar (60) | - | 要求 | - |
NameSuffix |
字符串 |
用户名后缀。格式:nvarchar (60) | - | - | - |
首选名称 |
字符串 |
用户的首选名称。格式:nvarchar(60) | - | - | - |
职务高低 |
字符串 |
用户的职称。格式:nvarchar (255) | - | - | - |
CostCenter |
字符串 |
用户的成本中心。格式:nvarchar (25) | - | - | 要求公司详细信息范围。 |
公司雇员ID |
字符串 |
用户的员工ID。格式:nvarchar(48) | - | - | 要求公司详细信息范围。必须是公司里独一无二的。 |
部门 |
字符串 |
用户的部门。格式:nvarchar(60) | - | - | 要求公司详细信息范围。必须已经在公司配置中设置。 |
PreferredLanguage |
字符串 |
用户的首选语言环境。例如:United English为en-US。格式:varchar (20) | - | - | 请参阅下面允许的规范值列表。不在此列表中的值将写入空字符串 |
EReceiptOptIn |
布尔值 |
用户是否已选择接收电子收据。格式:真\假 | - | - | |
有公开预订 |
布尔值 |
用户是否具有TriLink用户(以前的Open Booking用户)权限。格式:真\假 | 无法更新 | - | - |
CountryCode |
字符串 |
国家代码从ISO 3166-1 alpha-2国家代码规范。格式:char (2) | 无法更新 | - | - |
公司名称 |
字符串 |
用户的公司名称。格式:nvarchar(255) | 无法更新 | - | - |
CompanyID |
字符串 |
用户的公司ID。格式:varchar (255) | 无法更新 | - | 要求公司详细信息范围。 |
RuleClass |
字符串 |
用户的规则类。格式:nvarchar (60) | - | - | 必须已在公司中设置。 |
TravelConfigID |
字符串 |
用户的TravelConfig。格式:varchar (255) | - | 要求 | - |
MedicalAlerts |
字符串 |
用户的医疗警报。格式:nvarchar(255) | - | - | 需要医疗警报范围。 |
AgencyNumber |
字符串 |
TravelConfig的代理IATA号码。格式:varchar (255) | 无法更新 | - | - |
SearchID |
字符串 |
用户的搜索ID。格式:varchar (64) | - | - | - |
GDSProfileName |
字符串 |
用户的GDS配置文件名称。格式:varchar (60) | - | - | 需要TMC特定的范围。 |
SabreProfileId |
字符串 |
用户的Sabre旅行资料Id。格式:varchar (60) | - | - | 需要TMC特定的范围。 |
UUID |
字符串 |
用户的唯一标识符。格式:GUID, 32个字符 | 无法更新 | - | 需要TMC特定的范围。 |
笔记:如果提供了MiddleName,则TSAInfo部分中的NoMiddleName标志将设置为false。
提供的紧急联系信息。
的名字 | 数据类型 | 描述 | 更新 | 创建 | 评论 |
---|---|---|---|---|---|
的名字 |
字符串 |
紧急联系人名称格式:nvarchar(255) | - | - | - |
的关系 |
字符串 |
与用户的关系。价值观是:配偶,兄弟,父母,姐妹,生活伴侣,其他 | - | - | - |
电话 |
列表 |
- | - | - | 如果提供了多个相同电话类型的值,则只保存最后一个值。请参阅下面的列表元素。 |
地址 |
地址 |
街道地址。格式:nvarchar (max) | - | - | - |
的名字 | 数据类型 | 描述 | 更新 | 创建 | 评论 |
---|---|---|---|---|---|
街 |
字符串 |
街道地址。格式:nvarchar (max) | - | - | - |
城市 |
字符串 |
城市名称。格式:nvarchar(30) | - | - | - |
StateProvince |
字符串 |
州或省。格式:nvarchar(30) | - | - | - |
CountryCode |
字符串 |
国家代码来自ISO 3166-1 alpha-2国家代码规范。格式:char (2) | - | - | - |
PostalCode |
字符串 |
邮政编码。格式:nvarchar (20) | - | - | - |
的名字 | 数据类型 | 描述 | 更新 | 创建 | 评论 |
---|---|---|---|---|---|
PhoneNumber |
字符串 |
紧急联系人的电话号码。格式:nvarchar(60) | - | - | unicode字符。 |
类型 |
字符串 |
它包含一个“类型”属性,其值为Daily或Alternate。 | 要求 | 要求 | - |
电话机的父元素包含每个电话机的Telephone子元素。电话元素具有响应类部分中显示的属性,并包含以下子元素:
的名字 | 数据类型 | 描述 | 更新 | 创建 | 评论 |
---|---|---|---|---|---|
类型属性 |
字符串 |
类型的电话。价值包括:家庭、工作、传真、寻呼机、其他和单元 | 要求 | 要求 | - |
接触蛋白属性 |
布尔值 |
用户是否已选择通过此电话联系。仅在手机类型为手机时显示。格式:真\假 | - | - | - |
PrimaryMobile属性 |
布尔值 |
这是用户首选的移动设备。格式:真\假 | - | - | - |
CountryCode |
字符串 |
国家代码从ISO 3166-1 alpha-2国家代码规格格式:字符(2) | 必需(单元) | 必需(单元) | 所需的单元格类型。 |
PhoneNumber |
字符串 |
用户输入的电话号码,可以包含()或-等字符。对于手机,“号码”只能包含数字、破折号、括号和空格。格式:nvarchar (60) |
必需(单元) | 必需(单元) | 所需的单元格类型。 |
扩大 |
字符串 |
电话扩展。格式:nvarchar (60) | - | - | - |
MobileDevice |
字符串 |
移动设备的操作系统。值: 安卓手机 安卓平板电脑 黑莓 iOS手机 iOS平板电脑 不是智能手机 其他iOS设备 其他智能手机 未知的 窗口移动 |
- | - | - |
美孚烯 |
字符串 |
用户分配给移动设备的名称。格式:nvarchar(255) | - | - | - |
笔记
CountryCode
,设备名称
,设备类型
,ContactOptIn
,IsPrimaryMobile
PrimaryMobile
:PrimaryMobile
在“更改手机”中指定,则所有手机更改都将被拒绝。如果仅提供一(1)部手机,则将其标记为主手机。的地址
父元素包含每个包含地址的address子元素。address元素具有响应类部分中显示的属性,并包含以下子元素:
笔记: Address子元素的返回值与用户输入的值一致。字段不强制格式化,可能有各种各样的值。
的名字 | 数据类型 | 描述 | 更新 | 创建 | 评论 |
---|---|---|---|---|---|
类型属性 |
字符串 |
地址类型。价值观是:家庭或工作 | 要求 | 要求 | 如果为任一地址类型提供了多个值,则最后一个值将保存在创建/更新中。 |
街 |
字符串 |
街道地址。格式:nvarchar (max) | - | - | - |
城市 |
字符串 |
城市名称。格式:nvarchar(30) | - | - | - |
StateProvince |
字符串 |
州或省。格式:nvarchar(30) | - | - | - |
CountryCode |
字符串 |
国家代码从ISO 3166-1 alpha-2国家代码规范。格式:char (2) | - | - | - |
PostalCode |
字符串 |
邮政编码。格式:nvarchar (20) | - | - | - |
经度 |
字符串 |
工作地址的经度值。 | 无法更新 | - | - |
纬度 |
字符串 |
工作地址的纬度值。 | 无法更新 | - | - |
的国有企业
父元素包含国有化
子元素。的国有化
元素包含以下子元素:
的名字 | 数据类型 | 描述 | 更新 | 创建 | 评论 |
---|---|---|---|---|---|
国家编号 |
字符串 |
用户的国家识别号码。格式:nvarchar (100) | - | - | 不接受unicode。只保存一个国家ID值。如果提供多个,则返回W016警告消息。 |
IssuingCountry |
字符串 |
颁发国民身份证的国家。格式:varchar(2) | - | - | - |
到期 |
日期 |
国民身份证的有效期。格式:YYYY-MM-DD |
- | - | Min - 01/01/1753, Max - 12/31/9999 |
笔记:只能使用一个身份证。
的DriversLicenses
父元素包含DriversLicense
子元素。
DriversLicense
元素包含以下子元素:的名字 | 数据类型 | 描述 | 更新 | 创建 | 评论 |
---|---|---|---|---|---|
DriversLicenseNumber |
字符串 |
用户的驾驶执照识别号码。格式:nvarchar (100) | - | - | 仅保存一个驾照号码值。如果提供多个,则返回W016警告消息。 |
IssuingCountry |
字符串 |
许可证签发的国家。格式:varchar (2) | - | - | - |
IssuingState |
字符串 |
执照签发的州。格式:nvarchar (30) | - | - | - |
到期 |
日期 |
许可证的到期日期。格式:YYYY-MM-DD |
- | - | Min - 01/01/1753, Max - 12/31/9999 |
笔记:只能接受一张驾驶执照。
向用户添加新passport时设置的标志。
的名字 | 数据类型 | 描述 | 更新 | 创建 | 评论 |
---|---|---|---|---|---|
HasNoPassport |
布尔值 |
格式:真\假。 | - | 如果护照增加了价值,那么这个价值就会变成假的。 | *如果显式设置为false,护照信息必须存在于用户的配置文件中或在相同的API调用中提供。 *如果显式设置为true,则用户的配置文件中必须没有护照信息。 |
用户资料中的护照列表:
的名字 | 数据类型 | 描述 | 更新 | 创建 | 评论 |
---|---|---|---|---|---|
PassportNumber |
字符串 |
用户的护照号码。格式:nvarchar (100) | 要求 | 要求 | - |
PassportNationality |
字符串 |
用户的护照国籍。格式:字符(2) | 要求 | 要求 | - |
PassportExpiration |
日期 |
用户护照的过期日期。格式:YYYY-MM-DD |
- | - | 最小值-1900年1月1日,最大值-2079年6月6日 |
签发护照日期 |
日期 |
用户护照签发的日期。格式:YYYY-MM-DD |
- | - | 最小值-1900年1月1日,最大值-2079年6月6日 |
PassportCityIssued |
字符串 |
签发用户护照的城市。格式:nvarchar(60) | - | - | - |
PassportCountryIssued |
字符串 |
国家代码从ISO 3166-1 alpha-2国家代码规范。格式:char (2) | - | - | - |
笔记:一个用户只能有两本护照。如果提供两本以上护照,则返回W016警告信息。
用户资料中的签证列表。
的名字 | 数据类型 | 描述 | 更新 | 创建 | 评论 |
---|---|---|---|---|---|
VisaNationality |
字符串 |
用户的签证国籍。格式:char (2) | 要求 | 要求 | - |
VisaNumber |
字符串 |
用户的签证国籍。格式:nvarchar (100) | 要求 | 要求 | - |
VisaType |
字符串 |
用户的签证类型。取值为Unknown、SingleEntry、DoubleEntry、MultiEntry、ESTA、ETA和申根签证。 | - | - | - |
VisaDateIssued |
日期 |
签发用户签证的日期。格式:YYYY-MM-DD |
- | - | 最小- 01/01/1900最大- 06/06/2079 |
内蒸腾 |
日期 |
用户的签证过期日期。格式:YYYY-MM-DD |
- | - | 最小-01/01/1900最大- 06/06/2079 |
VisaCityIssued |
字符串 |
用户签证签发的城市。格式:nvarchar (60) | - | - | - |
VisaCountry |
字符串 |
国家代码从ISO 3166-1 alpha-2国家代码规范。格式:char (2) | - | - | - |
笔记:签证将与现有的签证同步。名单中未提供的现有签证将被删除。
的emailaddress
父元素包含EmailAddress
每个包含的电子邮件地址的子元素。它包含以下子元素:
的名字 | 数据类型 | 描述 | 更新 | 创建 | 评论 |
---|---|---|---|---|---|
EmailAddress |
字符串 |
用户的电子邮件地址。格式:Varchar (255) | - | - | - |
接触属性 |
布尔值 |
联系人属性指定是否应将电子邮件地址用于旅行通知。格式:真\假。 | - | - | - |
类型属性 |
字符串 |
电子邮件地址的类型。价值观有:商务、个人、主管、旅行安排者、商务2、其他1和其他2。 | 要求 | 要求 | 主管和旅行安排不能更新。每种类型只允许有一种。返回W016错误 |
父元素RatePreferences包含以下子元素:
的名字 | 数据类型 | 描述 | 更新 | 创建 | 评论 |
---|---|---|---|---|---|
AAARate |
布尔值 |
用户是否符合AAA速率。格式:真\假 | - | - | - |
AARPRate |
布尔值 |
用户是否符合AARP费率。格式:真\假 | - | - | - |
GovtRate |
布尔值 |
用户是否符合政府费率的条件。格式:真\假 | - | - | - |
MilitaryRate |
布尔值 |
用户是否符合军事费用标准。格式:真\假 | - | - | - |
的discountcode
父元素包含DiscountCode
每个包含的折扣代码的子元素。
的名字 | 数据类型 | 描述 | 更新 | 创建 | 评论 |
---|---|---|---|---|---|
DiscountCode |
字符串 |
指定供应商的折扣代码。 | - | - | 无法更新 |
供应商的属性 |
字符串 |
指定折扣代码的供应商名称。 | - | - | 无法更新 |
注意:折扣代码元素不可创建或更新。
的空气
父元素包含用户的空中旅行首选项,并包含以下子元素:
的名字 | 数据类型 | 描述 | 更新 | 创建 | 评论 |
---|---|---|---|---|---|
AirMemberships |
- | 只有当请求来自该旅行类型的旅行供应商或TMC时,才会出现AirMemberships元素。该元素包含AirMembership子元素. | - | - | - |
座位 |
- | 该元素包含空气座椅子元件. | - | - | - |
餐 |
字符串 |
这个父元素包含指示旅行者的膳食偏好的MealCode子元素。见参考可能的值。 | - | - | 默认为普通餐 |
家庭机场 |
字符串 |
用户的家庭机场。varchar (3) | - | - | 必须是现有的IATA代码。 |
航空公司 |
字符串 |
其他与空气有关的说明 | - | - | - |
的名字 | 数据类型 | 描述 | 更新 | 创建 | 评论 |
---|---|---|---|---|---|
卖方代码 |
字符串 |
管理忠诚度计划的供应商代码。varchar (2) | 要求 | 要求 | 必须是成员类型的有效VendorCode。此清单可根据要求提供。 |
AccountNo |
字符串 |
忠诚度计划中的用户帐户标识符。varchar (60) | 要求 | 要求 | - |
状态 |
字符串 |
用户在忠诚度计划中的当前级别的名称。varchar (100) | - | - | - |
StatusBenefits |
字符串 |
描述当前状态下忠诚计划的好处。 | - | - | - |
总分 |
字符串 |
用户在忠诚计划中的积分总数。 | - | - | - |
分段总计 |
字符串 |
用户在忠诚度计划中的总细分。 | - | - | - |
NextStatus |
字符串 |
忠诚度计划中更高地位等级的名称或描述。 | - | - | - |
点直到下一个状态 |
字符串 |
下一个状态级别所需的忠诚度点数。 | - | - | - |
分节状态 |
字符串 |
预订细分到下一个状态级别。 | - | - | - |
IsSenator |
布尔值 |
德国汉莎航空公司特定的字段。格式:真\假 | - | - | - |
的名字 | 数据类型 | 描述 | 更新 | 创建 | 评论 |
---|---|---|---|---|---|
行间位置码 |
字符串 |
飞机排中的首选位置。格式:窗口 ,过道 ,中间 ,唐卡 . |
- | - | - |
部分位置代码 |
字符串 |
优先选择平面位置。格式:舱壁 ,向前 ,后 ,出口 ,唐卡 . |
- | - | - |
的栏杆
父元素包含用户的火车出行首选项,并包含以下子元素:
的名字 | 数据类型 | 描述 | 更新 | 创建 | 评论 | |
---|---|---|---|---|---|---|
座位 |
字符串 |
此元素包含座椅首选项。格式:过道 ,窗口 ,唐卡 |
- | - | - | |
教练 |
字符串 |
此元素包含coach首选项。格式:室 ,教练 ,CoachWithTable ,唐卡 |
- | - | - | |
NoiseComfort |
字符串 |
此元素包含噪音舒适度偏好。格式:QuietSpace ,MobileSpace ,唐卡 |
- | - | - | |
床上 |
字符串 |
这个元素包含了床的偏好。格式:较低的 ,上 ,中间 ,唐卡 |
- | - | - | |
床类 |
字符串 |
此元素包含床类别首选项。格式:WomenOnly ,梅农 ,唐卡 |
- | - | - | |
泊位 |
字符串 |
此元素包含泊位首选项。格式:较低的 ,上 ,中间 ,唐卡 |
- | - | - | |
甲板 |
字符串 |
此元素包含牌组首选项。格式:较低的 ,上 ,唐卡 |
- | - | - | |
空间类型 |
字符串 |
此元素包含空格类型首选项。格式:全景 ,SeatWithTable ,独奏 ,沙龙 ,亭 ,InclineSeat ,多西德贝西德酒店 ,DuoFaceToFace ,俱乐部6 ,俱乐部4 ,卡雷 ,DisabledCompanionSpace ,唐卡 |
- | - | - | |
FareSpaceComfort |
字符串 |
此元素包含票价空间舒适度偏好。格式:专注的事业 ,业务 ,中等收入 ,休闲 ,StandardLeisure ,唐卡 |
- | - | - | |
SpecialMeals |
字符串 |
此元素包含特殊的膳食偏好。格式:低脂 ,LowSalt ,GlutenFree ,糖尿病 ,穆斯林 ,犹太教徒 ,素食主义者 ,VegetarianLactoOvo ,唐卡 |
- | - | - | |
突发事件 |
字符串 |
此元素包含意外事件首选项。格式:自行车 ,WomenOnly ,WheelchairSpace ,唐卡 |
- | - | - | |
RailMemberships |
- | 该元素包含RailMembership子元素 | - | - | - | - |
的名字 | 数据类型 | 描述 | 更新 | 创建 | 评论 | |
---|---|---|---|---|---|---|
卖方代码 |
字符串 |
管理忠诚度计划的供应商代码。varchar (2) | 要求 | 要求 | 必须是成员类型的有效供应商代码。此清单可根据要求提供。 | |
AccountNo |
字符串 |
忠诚度计划中的用户帐户标识符。varchar (60) | 要求 | 要求 | 见下文。 | |
状态 |
字符串 |
用户在忠诚度计划中的当前级别的名称。varchar (100) | - | - | - | |
StatusBenefits |
字符串 |
描述当前状态下忠诚计划的好处。 | - | - | - | |
总分 |
字符串 |
用户在忠诚计划中的积分总数。 | - | - | - | |
分段总计 |
字符串 |
用户在忠诚度计划中的总细分。 | - | - | - | |
到期 |
DateTime |
用户在忠诚计划中的截止日期。Min - 01/01/1753, Max - 12/31/9999 | - | - | - | - |
NextStatus |
字符串 |
忠诚度计划中更高地位等级的名称或描述。 | - | - | - | |
点直到下一个状态 |
字符串 |
下一个状态级别所需的忠诚度点数。 | - | - | - | |
分节状态 |
字符串 |
预订细分到下一个状态级别。 | - | - | - | |
BahnCardClass |
字符串 |
铁路卡类。有效值为First和Second。 | - | - | - | |
班卡类型 |
字符串 |
Bahn卡类型。有效值包括NA(适用于非铁路项目)、Card25、Card50、Card100、Business25和Business50。 | - | - | - |
的汽车
父元素包含用户的汽车旅行首选项。它包含以下子元素:
的名字 | 数据类型 | 描述 | 更新 | 创建 | 评论 |
---|---|---|---|---|---|
汽车烟雾代码 |
字符串 |
吸烟车厢优先。格式:唐卡 ,不吸烟 ,吸烟 |
- | - | - |
汽车GPS |
布尔值 |
汽车GPS的偏好。格式:真\假。 | - | - | - |
CarType |
字符串 |
车型偏好。价值观是: 唐卡 迷你 经济 EconomyHybrid 紧凑的 CompactHybrid 中间 IntermediateHybrid 标准 StandardHybrid 实际大小的 FullSizeHybrid 小货车 奢侈 溢价 StandardSUV 中间紫外 FullSizeSUV FullSizePickup 专业 |
- | - | - |
CarMemberships |
- | CarMemberships元素只有在请求来自该旅行类型的旅行供应商或TMC时才会出现。该元素包含CarMembership子元素为每一个包含的成员。 | - | - | - |
CarOther |
字符串 |
其他与汽车相关的描述。格式:varchar(30) | - | - | - |
CarSkiRack |
布尔值 |
汽车滑雪架偏好。格式:真\假。 | - | - | |
CarTransmission |
字符串 |
汽车传动类型。值:唐卡 ,自动的 ,手册 |
- | - | - |
的名字 | 数据类型 | 描述 | 更新 | 创建 | 评论 |
---|---|---|---|---|---|
卖方代码 |
字符串 |
管理忠诚度计划的供应商代码。varchar (2) | 要求 | 要求 | 必须是成员类型的有效供应商代码。此清单可根据要求提供。 |
AccountNo |
字符串 |
忠诚度计划中的用户帐户标识符。varchar (60) | 要求 | 要求 | 见下文。 |
状态 |
字符串 |
用户在忠诚度计划中的当前级别的名称。varchar (100) | - | - | - |
StatusBenefits |
字符串 |
描述当前状态下忠诚计划的好处。 | - | - | - |
总分 |
字符串 |
用户在忠诚计划中的积分总数。 | - | - | - |
分段总计 |
字符串 |
用户在忠诚度计划中的总细分。 | - | - | - |
到期 |
DateTime |
用户在忠诚计划中的截止日期。 | - | - | Min - 01/01/1753, Max - 12/31/9999 |
NextStatus |
字符串 |
忠诚度计划中更高地位等级的名称或描述。 | - | - | - |
点直到下一个状态 |
字符串 |
下一个状态级别所需的忠诚度点数。 | - | - | - |
分节状态 |
字符串 |
预订细分到下一个状态级别。 | - | - | - |
的酒店
父元素包含用户的酒店旅行首选项。它包含以下子元素:
的名字 | 数据类型 | 描述 | 更新 | 创建 | 评论 |
---|---|---|---|---|---|
SmokingCode |
字符串 |
吸烟室优先。价值观:唐卡 ,不吸烟 ,吸烟 |
- | - | - |
HotelMemberships |
- | 只有当请求来自该旅行类型的旅行供应商或TMC时,此父元素才会出现。该元素包含HotelMembership子元素为每一个包含的成员。 | - | - | - |
将可能 |
字符串 |
酒店房间的偏好。值:唐卡 ,君主 ,女王 ,双 ,双胞胎 ,单 ,残疾 |
- | - | - |
HotelOther |
字符串 |
其他酒店相关说明。格式:varchar(30) | - | - | - |
我喜欢泡沫枕头 |
布尔值 |
用户是否喜欢泡沫枕头。格式:真\假。 | - | - | - |
PreferCrib |
布尔值 |
用户是否喜欢婴儿床。格式:真\假。 | - | - | - |
PreferRollawayBed |
布尔值 |
用户是否喜欢使用可折叠床。格式:真\假。 | - | - | - |
首选健身房 |
布尔值 |
用户是否更喜欢有健身房的酒店。格式:true\false。 | - | - | - |
PreferPool |
布尔值 |
用户是否喜欢有游泳池的酒店。格式:真\假。 | - | - | - |
优先餐厅 |
布尔值 |
用户是否更喜欢有餐厅的酒店。格式:真\假。 | - | - | - |
优先通行权 |
布尔值 |
用户是否需要轮椅进入。格式:真\假。 | - | - | - |
PreferAccessForBlind |
布尔值 |
用户是否需要盲人入住的房间。格式:真\假。 | - | - | - |
优先客房服务 |
布尔值 |
用户是否喜欢提供客房服务的酒店。格式:真\假。 | - | - | - |
PreferEarlyCheckIn |
布尔值 |
用户是否喜欢提前入住酒店。格式:真\假。 | - | - | - |
的名字 | 数据类型 | 描述 | 更新 | 创建 | 评论 |
---|---|---|---|---|---|
卖方代码 |
字符串 |
管理忠诚度计划的供应商代码。varchar (2) | 要求 | 要求 | 必须是成员类型的有效供应商代码。此清单可根据要求提供。 |
AccountNo |
字符串 |
忠诚度计划中的用户帐户标识符。varchar (60) | 要求 | 要求 | 见下文。 |
状态 |
字符串 |
用户在忠诚度计划中的当前级别的名称。varchar (100) | - | - | - |
StatusBenefits |
字符串 |
描述当前状态下忠诚计划的好处。 | - | - | - |
总分 |
字符串 |
用户在忠诚计划中的积分总数。 | - | - | - |
分段总计 |
字符串 |
用户在忠诚度计划中的总细分。 | - | - | - |
到期 |
DateTime |
用户在忠诚计划中的截止日期。 | - | - | Min - 01/01/1753, Max - 12/31/9999 |
的CustomFields
父元素包含CustomField
每个字段的子元素。
的名字 | 数据类型 | 描述 | 更新 | 创建 | 评论 |
---|---|---|---|---|---|
CustomField |
字符串 |
自定义字段的值。格式:varchar (255) | - | - | - |
名称属性 |
字符串 |
自定义字段的名称。格式:varchar(255) | 要求 | 要求 | - |
与某个用户关联的用户列表:
的名字 | 数据类型 | 描述 | 更新 | 创建 | 评论 |
---|---|---|---|---|---|
FirstName |
字符串 |
安排人/经理的名字。格式:varchar (60) | 无法更新 | - | - |
姓 |
字符串 |
安排人/经理的姓。格式:varchar (60) | 无法更新 | - | - |
EmailAddress |
字符串 |
安排人/经理的电子邮件地址。格式:varchar (255) | 无法更新 | - | - |
LoginId |
字符串 |
安排人/经理的登入Id | 要求 | 要求 | - |
类型属性 |
字符串 |
编曲/经理的角色。取值为:arrange、Manager | 要求 | 要求 | - |
PrimaryIndicatorFlag属性 |
布尔值 |
对于安排程序类型,表示主安排程序。格式:真\假。 | - | - | - |
笔记:
FirstName
,姓
,电子邮件
不能被更新。管理者
和安排人
必须与要分配的用户在同一公司。主要指示标志
发送为true,则安排程序将被标记为主。与用户相关的赞助商列表:
的名字 | 数据类型 | 描述 | 更新 | 创建 | 评论 |
---|---|---|---|---|---|
NonEmployeeUserType |
字符串 |
非雇员的用户类型。值:承包商 ,学生/实习生 ,雇佣候选人 ,邀请旅行者 ,依赖/配偶 ,董事会成员 ,其他 |
要求 | 要求 | - |
SponsorName |
字符串 |
赞助商的名字。格式:varchar (255) | 无法更新 | - | - |
SponsorshipStartDate |
日期 |
赞助开始日期。格式:YYYY-MM-DD |
要求 | 要求 | - |
SponsorshipEndDate |
日期 |
赞助截止日期。格式:YYYY-MM-DD |
要求 | 要求 | - |
LoginID |
字符串 |
赞助商的名字。格式:varchar (255) | 要求 | 要求 | - |
笔记:
SponsorshipEndDate
一定是为了SponsorshipStartDate
交通安全管理局(TSA)提供了详细信息。
的名字 | 数据类型 | 描述 | 更新 | 创建 | 评论 |
---|---|---|---|---|---|
性别 |
字符串 |
用户的性别。值:男性的 ,女 |
- | - | - |
出生日期 |
日期 |
用户的出生日期。格式:YYYY-MM-DD .最小值-1900年1月1日,最大值-2079年6月6日 |
- | - | - |
NoMiddleName |
布尔值 |
格式:对/错 |
- | - | - |
PreCheckNumber |
字符串 |
用户预查号码。格式:varchar (255) | - | - | - |
修订编号 |
字符串 |
用户的赔偿号码。格式:varchar (255) | - | - | - |
笔记:NoMiddleName
:如果配置文件有中间名,NoMiddleName
覆盖为假
与用户关联的未使用的票据列表
的名字 | 数据类型 | 描述 | 更新 | 创建 | 评论 |
---|---|---|---|---|---|
航空公司 |
字符串 |
供应商的名字。格式:Varchar (255) | 要求 | 要求 | - |
TicketNumber |
字符串 |
未使用的票号。格式:Varchar (255) | 要求 | 要求 | - |
RecordLocator |
字符串 |
未使用的票据记录定位器。格式:Varchar (6) | - | - | - |
BaseFare |
字符串 |
未使用票的基本票价。格式:Varchar (255) | - | - | - |
税 |
字符串 |
未使用车票的税费。格式:Varchar(255) | - | - | - |
费用 |
字符串 |
未使用票的费用。格式:Varchar (255) | - | - | - |
通货 |
字符串 |
未使用票的货币。格式:Varchar (3) | - | - | - |
票型 |
字符串 |
未使用票据的类型。格式:Varchar (1) | - | - | - |
IssueDate |
日期 |
未用票的出票日期。格式:YYYY-MM-DD . |
- | - | Min - 01/01/1753, Max - 12/31/9999 |
到期日 |
日期 |
未使用票的截止日期。格式:YYYY-MM-DD . |
- | - | Min - 01/01/1753, Max - 12/31/9999 |
笔记 |
字符串 |
与未使用票证相关的说明。格式:Varchar (255) | - | - | - |
与用户关联的未使用的西南航空机票列表。
的名字 | 数据类型 | 描述 | 更新 | 创建 | 评论 |
---|---|---|---|---|---|
RecordLocator |
字符串 |
未使用的票据记录定位器。格式:Varchar (255) | 要求 | - | - |
TicketAmount |
字符串 |
未使用票的金额。格式:Varchar (255) | - | - | - |
通货 |
字符串 |
未使用票的货币。格式:Varchar (3) | - | - | - |
到期日 |
日期 |
未使用票的截止日期。格式:YYYY-MM-DD . |
- | - | Min - 01/01/1753, Max - 12/31/9999 |
与用户关联的advantage成员资格列表:
的名字 | 数据类型 | 描述 | 更新 | 创建 | 评论 |
---|---|---|---|---|---|
卖方代码 |
字符串 |
管理成员资格计划的供应商的代码。格式:Varchar(2) | 要求 | 要求 | - |
VendorType |
字符串 |
供应商的类型。值:空气 ,栏杆 ,汽车 ,酒店 |
要求 | 要求 | - |
程序编号 |
字符串 |
会员计划编号。格式:Varchar (20) | 要求 | 要求 | - |
OriginCode |
字符串 |
原点的代码。格式:Varchar (12) | - | - | - |
DestinationCode |
字符串 |
目标代码。格式:Varchar (12) | - | - | - |
程序代码 |
字符串 |
程序代码。格式:Varchar(20) | 要求 | 要求 | - |
到期日 |
日期 |
过期日期。格式:YYYY-MM-DD .最小值-1900年1月1日,最大值-2079年6月6日 |
- | - | - |
OptionCode |
字符串 |
选项代码。格式:Varchar(20) | - | - | - |
ProgramName |
字符串 |
这个项目的名字。格式:Varchar (20) | 无法更新 | - | - |
笔记:
VendorType
,卖方代码
,程序代码
,卡号
被识别并抛出警告。OriginStationCode
和目的站代码
字段已弃用,不应再使用。使用OriginCode
和DestinationCode
代替。当XML没有按照可读取的方式进行格式化时,就会发生此错误消息。
< >错误 XML文档中出现错误(1,147)。消息> < /<服务器时间>2017-06-22T16:51:37<标识>3 bdbc49e - 8793 - 4515 - ba0e f9c71ada7330< / Id >> < /错误
找到错误原因的最佳方法是将消息的正文与旅游形象XSD.您可以使用免费的在线网站进行验证,例如https://www.freeformatter.com/xml-validator-xsd.html
可以在更新和创建时返回的代码和消息类型:
代码 | 消息类型 | 笔记 | 例子 |
---|---|---|---|
S001 | 成功 | 过程成功完成。 | 成功,没有错误或警告报告。 |
E001 | 没有访问 | 不能访问用户数据。 | - |
E002 | 缺少必需字段 | 记录的字段是更新或创建所必需的,未进行任何更改。 | - |
W001 | 无效的正则表达式 | 给定的数据与预期的正则表达式不匹配。 | - |
W002 | 无效长度 | 给定的数据太长或太短。 | - |
W003 | 没有同伴 | 该用户不在公司内。 | - |
W004 | 重复的条目 | 给定的数据是不允许重复的。 | - |
W005 | 复制LoginId | 给定的LoginID 是重复的。 |
- |
W006 | 的范围 | 给定的数据超出范围。 | - |
W007 | 字段是必需的 | 无法清除给定字段。 | - |
W009 | 无效的账号 | 由于长度、Luhn等原因,账号检查失败。 | - |
W010 | 无效的供应商代码 | 供应商代码无效。 | - |
W011 | 不能改变 | 不能更改给定的字段。 | - |
W012 | 主单元号错误 | 数据违反了一项主要的手机要求。 | - |
W013 | 无效的自定义字段 | 为自定义字段提供的数据无效。 | - |
W014 | 无效的日期范围 | 所提供的数据超出可接受的日期范围。 | - |
W015 | 无效的GUID | GUID无效。 | - |
W016 | 物品太多 | 给定的列表中有太多的项目。 | - |
W017 | 无法访问VendorCode | 用户无法访问给定的供应商代码。 | - |
如果提供了不正确的API凭据,服务将返回标准响应,例如403 Forbidden。在某些情况下,API在生成400 Bad Request响应时将返回额外的信息。它可能在响应体中包含以下代码:
得到{InstanceURI}/api/travelprofile/v2.0/profile HTTP/1.1{访问令牌}
得到https://www.concursolutions.com/api/travelprofile/v2.0/profile?userid_type=登录名和用户id\u值=cm@example.com HTTP/1.1授权:OAuth{访问令牌}
得到{InstanceURI}/api/travelprofile/v2.0/profile HTTP/1.1{访问令牌}
得到https://www.concursolutions.com/api/travelprofile/v2.0/profile?userid_type=登录名和用户id\u值=cm@example.com HTTP/1.1授权:OAuth{访问令牌}
POST https://www.concursolutions.com/api/travelprofile/v2.0/profile HTTP/1.1授权:OAuth{访问令牌}
< ProfileResponsexmlns: xsi =“http://www.w3.org/2001/XMLSchema-instance”Action =“创造”罗吉尼=”“威廉。never@email.com">一般> < 威廉< / FirstName >< LastName >从来没有< / LastName > 默认规则类< / RuleClass >< TravelConfigID >555< / TravelConfigID >一般> < /<密码>密码123< /密码>< / ProfileResponse >
POST https://www.concursolutions.com/api/travelprofile/v2.0/profile HTTP/1.1授权:OAuth{访问令牌}
< ProfileResponsexmlns: xsi =“http://www.w3.org/2001/XMLSchema-instance”Action =“更新”罗吉尼=”“威廉。never@email.com">一般> < 比尔< / FirstName >一般> < /< / ProfileResponse >
此端点提供自指定日期以来已更新的旅行简介摘要列表。响应被分成多个页面。
得到{InstanceURI}/ api / travelprofile /版本/总结?最后修改日期=2020 - 01 - 01 - t01:00:00&travelconfigs=100,200,3000 HTTP/1.1授权:OAuth{访问令牌}
LastModifiedDate是必需的。所有其他请求参数都是可选的。可用的请求参数如下所示:
参数名称 | 必需的/可选 | 参数类型 | 数据类型 | 描述 |
---|---|---|---|---|
最后修改日期 |
要求 | 路径 | 字符串 |
UTC格式的日期和时间,配置文件必须在此之后更新才能包含在响应中。格式:YYYY-MM-DDThh: mm: ss |
页面 |
可选 | 路径 | 字符串 |
要检索的页数。如果页面超出了现有页面的数量,则响应元素将为空。 |
ItemsPerPage |
可选 | 路径 | 字符串 |
每页旅行简介的数量。最大值为200。缺省值为200。 |
travelConfigs |
可选 | 路径 | 字符串 |
一个或多个配置ID,用逗号分隔。 |
应用程序/xml
授权:OAuth {access_token}
在哪里access_token
是您想要检索其旅行概要摘要的用户的OAuth 2.0访问令牌。如果您想访问公司范围内的旅行配置文件信息,与OAuth 2.0访问令牌关联的用户帐户必须具有SAP Concur帐户,该帐户必须具有以下角色之一:专业Web服务管理员或标准Web服务管理员。
GET操作响应的数据模型。此处还提供了完整的架构定义:旅行简介概要V2 XSD
< ConnectResponse ><元数据>分页> </>< TotalItems/><页面/>< ItemsPerPage/>< PreviousPageURL/>/>分页> < /> < /元数据<数据>< ProfileSummary ><状态/>< LoginID/>< XmlProfileSyncID/>< ProfileLastModifiedUTC/>> < /数据< / ConnectResponse >
的ConnectResponse
根元素包含一般
,电话
,地址
,DriversLicenses
,emailaddress
,RatePreferences
,discountcode
,空气
,汽车
,酒店
,CustomFields
子元素。它具有响应类部分中显示的属性。
的元数据
父元素包含分页
子元素。
的分页
父元素包含响应的分页信息,并包含以下子元素:
元素名称 | 数据类型 | 描述 |
---|---|---|
TotalPages | 字符串 |
要返回的总页数。 |
总计项目 | 字符串 |
查询返回的概要文件的总数。 |
页面 | 字符串 |
当前响应中结果集的页码。 |
ItemsPerPage | 字符串 |
设置为每页显示的项目数。 |
PreviousPageURL | 字符串 |
指向结果前一页的URI。当没有以前的页面时,此元素将为空。 |
下一个页面URL | 字符串 |
下一组结果的URI。当没有下一页时,此元素将为空 |
父元素Data包含一个ProfileSummary
子元素,用于包含的每个旅行配置文件。
的ProfileSummary
元素包含响应的概要信息,它包含以下子元素:
元素名称 | 数据类型 | 描述 |
---|---|---|
状态 | 字符串 |
用户当前状态:激活或未激活。 |
LoginID | 字符串 |
SAP Concur用户登录ID。 |
XMLProfileSyncID | 字符串 |
用户的XML配置文件同步ID(如果可用)。 |
ProfileLastModifiedUTC | 字符串 |
上次修改旅行配置文件的日期(UTC)。格式:YYYY-MM-DDThh:MM:ss。 |
此示例获取在2015年1月1日之后修改的旅行概要摘要列表。
得到{InstanceURI}/ api / travelprofile /版本/总结?最后修改日期=2015-01-01T01:00:00 HTTP/1.1授权方式:OAuth{访问令牌}
HTTP/1.1 200 OK内容类型:application/xml
< ConnectResponse ><元数据>分页> << TotalPages >1< / TotalPages >< TotalItems >2<页>1< /页>< ItemsPerPage >200< / ItemsPerPage >< PreviousPageURL/>/>分页> < /> < /元数据<数据>< ProfileSummary >< >状态忙碌的> < /状态< LoginID >mariab@company1.com< XmlProfileSyncID >`字符串'123< / XmlProfileSyncID >< ProfileLastModifiedUTC >2015 - 01 - 01 - t01:00:00< / ProfileLastModifiedUTC >< ProfileSummary >< >状态不活跃的> < /状态< LoginID >peterk@company1.com< XmlProfileSyncID >456年“字符串”< / XmlProfileSyncID >< ProfileLastModifiedUTC >2015 - 01 - 01 - t01:00:00< / ProfileLastModifiedUTC >> < /数据< / ConnectResponse >