Concur Developer Platform

Transcription

Release NotesConcur Developer PlatformMonthAudienceApril 2015Concur Clients DRAFTPosted: Friday, April 3 2015DRAFTThe enhancements and changes described in this document may or may not beincluded in this release. Concur reserves the right to postpone implementation of—orcompletely remove—any enhancement/change mentioned here.ContentsNew: Users API . 1Users .1Scope .1Role .1URI .1Operations supported in this release .1Supported Content Types .2Coming Soon: Travel Profile API Version 2.0 . 3Overview.3Profile 1.0 Endpoints to Be Deprecated .3New Profile 2.0 Endpoints to Be Introduced .3Schema Changes .3Schema Additions.7Configuration . 10Release NotesApril 2015Page iConcur Developer PlatformConcur Clients DRAFT

New: Users APIUsersThe Users version 3.0 API is now available. You can use it to retrieve information for oneor more users from a Concur company. You can retrieve the user information in apaginated list or a series of search criteria that can be applied to narrow the number ofusers returned in the call. The maximum users per page is 100.ScopeThe calling application must have the User scope configured in order to call this API.RoleThe calling application must have the Web Services Administrator for Professional, orCan Administer for sersOperations supported in this release GET /common/users — Get a list of users up to 100. GET /common/users/{query parameters to filter results} — Get a list of users up toa 100 with one or more of the following filters: offset — Gets a list of users starting at the specified page offset. limit — Gets a list users up to the number of records specified by the limitvalue. primaryEmail — Gets user information for the user with the specified primary email address. employeeID — Gets user information for the user with the specified employeeID. user — Gets user information for the user with the specified login ID. lastName — Gets user information for the user with the specified last name. active — Gets a list of users that are active or inactive depending on thespecified value (true or false) for this query parameter.Release NotesPosted: Friday, April 3 2015Page 1Concur Developer PlatformConcur Clients DRAFT

Supported Content Types application/xml application/jsonFor more information, refer to the Users documentation tml#!/Users.Release NotesPosted: Friday, April 3 2015Page 2Concur Developer PlatformConcur Clients DRAFT

Coming Soon: Travel Profile API Version 2.0OverviewThe Travel Profile API is used to pass travel profile data from Concur to third parties, suchas fulfillment TMCs and TripLink vendors. To expand the capabilities of the Travel ProfileAPI, we are releasing a new version: Travel Profile version 2.0.We will release Travel Profile version 2.0 with the May 2015 release. Concur will requireeveryone to migrate to version 2.0 within six months, so by November 2015. We haveprovided 10 months advance notice to ensure you have adequate time to prepare tomigrate to version 2.0.Travel Profile version 2.0 implements several changes such as restructuring existingelements and adding new ones. In order to ensure that existing partners are not affectedby this change, we are offering a new Travel Profile endpoint.Important: After the initial release of Travel Profile API 2.0, Concur will no longer makechanges to Travel Profile version 1.0. In subsequent releases of Travel Profile API 2.0,Concur will not change the elements or values that were introduced in the initial releasebut may continue to add new elements and values as Concur sees fit. It is imperative thatpartners are aware of this and plan accordingly.Profile 1.0 Endpoints to Be DeprecatedWhen we release the Travel Profile version 2.0 API, we will deprecate the followingendpoints: /api/travelprofile/v1.0/profile /api/user/v1.0/profileNew Profile 2.0 Endpoints to Be IntroducedWhen we release the Travel Profile version 2.0 API, we will introduce the followingendpoints: /api/travelprofile/v2.0/profile /api/travelprofile/v2.0/summary — Provides a list of users with profile updatessince the value provided in the LastModifiedDate query parameter.Schema ChangesThe following table lists the schema changes for the GET operation response. Someelements have a new data type; others a new data type and new element name; andRelease NotesPosted: Friday, April 3 2015Page 3Concur Developer PlatformConcur Clients DRAFT

other elements have attribute changes. A new schema for v2.0 will be provided with theMay 2015 release.Schema elementNewdata type General EReceiptOptIn / /General Boolean General MarketingOptIn / /General Boolean EmailAddresses EmailAddressContact ”true false” / /EmailAddresses Boolean Car CarGPS / /Car Boolean Car CarSkiRack / /Car Boolean Hotel PreferFoamPillows / /Hotel Boolean Hotel PreferCrib / /Hotel Boolean Hotel PreferRollawayBed / /Hotel Boolean Hotel PreferGym / /Hotel Boolean Hotel PreferPool / /Hotel BooleanChanged casing from preferPool toPreferPool. Hotel PreferRestaurant / /Hotel BooleanCorrected spelling and changed casingfrom preferRestaraunt toPreferRestaurant. Hotel PreferWheelchairAccess/ /Hotel BooleanChanged casing frompreferWheelchairAccess toPreferWheelchairAccess. Hotel PreferAccessForBlind / /Hotel BooleanChanged casing frompreferAccessForBlind toPreferAccessForBlind. Hotel PreferRoomService / /Hotel BooleanChanged casing from preferRoomServiceto PreferRoomService. Hotel PreferEarlyCheckIn / /Hotel BooleanChanged casing frompreferEarlyCheckIn toPreferEarlyCheckIn.Release NotesPosted: Friday, April 3 2015Page 4Other changesConcur Developer PlatformConcur Clients DRAFT

Schema elementNewdata typeOther changes Air MealCode / /Air No changeThe meal preference is indicated in the MealCode element that is now a directchild of the Air element.In the current schema for GET Profileversion 1.0, the MealCode element is achild of the Meals which in turn is achild of the Air element: Air Meals MealCode / /Meals /Air The updated values for MealCode are:Regular Meal (DEFAULT VALUE) Air SectionPositionCode / /Air No changeBLMLBland / Low ResidueCHMLChild MealDBMLDiabetic MealFPMLFruit PlatterGFMLGluten Free MealHNMLHindu MealBBMLInfant / Baby MealKSMLKosher MealLCMLLow Calorie MealLSMLLow Salt / Sodium MealMOMLMuslim MealNSMLNo Salt MealNLMLNon Lactose MealPFMLPeanut Free MealSFMLSeafood MealVLMLVeg Lacto-OvoVGMLVegetarianKVMLVegetarian KosherRVMLVegetarian, RawUpdated values for wardRbecomesRearEbecomesExitRowD null becomesRelease NotesPosted: Friday, April 3 2015Page 5DontCareConcur Developer PlatformConcur Clients DRAFT

Schema elementNewdata typeOther changes Air InterRowPositionCode / /Air No changeUpdated values forInterRowPositionCode are:AisleWindowMiddleDontCare Telephones BooleanThe Primary Mobile Phone type isremoved and replaced with an attributeof the Telephone node for telephones oftype “Cell” only.BooleanThe ContactOptIn element is removedand replaced as an attribute of theTelephone node for telephones of type“Cell” only.No changeThe name of the SmokingCode childelement for Hotel changed toHotelSmokingCode. Telephone Type ”Cell”PrimaryMobile ”true false” / /Telephones Telephones Telephone Type ”Cell”ContactOptIn ”true false” / /Telephones Hotel HotelSmokingCode / Hotel Available values for HotelSmokingCodeare:No change Addresses Address Type ”Home Work” Street / City / StateProvince / PostalCode / DontCare NonSmoking SmokingThe street address is no longer parsedinto five sections. This change affectsthe following address types: Home Address Work Address Emergency Contact AddressThe new format is: CountryCode / Street Address City /Addresses StateProvincePostalCodeCountryCode EmailAddresses EmailAddressType ”Business Personal”/ /EmailAddresses Available types for EmailAddress are: Air AirSmokingCode /Air This element will be removedRelease NotesPosted: Friday, April 3 2015Page 6 Business PersonalConcur Developer PlatformConcur Clients DRAFT

Schema elementNewdata typeOther changesAvailable values for CarSmokingCodeare: Car CarSmokingCode /Car DontCare NonSmoking Smoking CarOption is renamed to CarType . Available values forCarType are: Car CarType /Car DontCare Economy Compact Intermediate Standard FullSize Luxury PremiumAvailable values for RoomType are: Hotel RoomType /Hotel DontCare King Queen Double Twin Single DisabilityCustomField elements have beenrestructured CustomFields CustomFieldName ”” Value /CustomField /CustomFields Schema AdditionsThis section summarizes new additions to the schema.Schema additionDescription ProfileResponse LoginId ”” Release NotesPosted: Friday, April 3 2015Page 7Concur Developer PlatformConcur Clients DRAFT

Roles Role Type ”Manager” FirstName / LastName / EmailAddress / /Role /Roles This element is returned only if theCompany Details scope has beenenabled. General CompanyEmployeeID / /General This element is returned only if theCompany Details scope has beenenabled. General CostCenter / /General This element is returned only if theCompany Details scope has beenenabled. General CompanyID / /General This element is returned only if thePassport Visa Information scope hasbeen enabled. Passports Passport PassportNumber / PassportNationality / PassportExpiration / PassportDateIssued / PassportCityIssued / PassportCountryIssued / /Passport /Passports HasNoPassport / This element is returned only if thePassport Visa Information scope hasbeen enabled. Visas This element is returned only if thePassport Visa Information scope hasbeen enabled. Visa VisaNationality / VisaNumber / VisaType / VisaDateIssued / VisaExpiration / VisaCityIssued / VisaCountryIssued / Release NotesPosted: Friday, April 3 2015Page 8Concur Developer PlatformConcur Clients DRAFT

/Visa /Visas This element is returned only if theEmergency Contact Informationscope has been enabled. EmergencyContact Name / Relationship / Available values for Relationshipare: Phones Phone Type ”DayTime Alternate” / Spouse /Phones Brother Address Parent Sister LifePartner Other Street / City / StateProvince / PostalCode / CountryCode / /Address EmergencyContact / This element is returned only if the TSAInformation scope has been enabled. TSAInfo Gender / DateOfBirth / NoMiddleName / PreCheckNumber / RedressNumber / /TSAInfo Profile Sponsors Sponsor NonEmployeeUserType / SponsorName / SponsorshipStartDate / SponsorshipEndDate / /Sponsor /Sponsors /Profile Release NotesPosted: Friday, April 3 2015Page 9Concur Developer PlatformConcur Clients DRAFT

ConfigurationTravel Profile version 2.0 works with the following Concur products: Travel for Concur Professional Travel for Concur StandardTo take advantage of the Travel version 2.0 API, partners need to code to the newendpoints. A new schema for v2.0 will be provided with the May 2015 release.Release NotesPosted: Friday, April 3 2015Page 10Concur Developer PlatformConcur Clients DRAFT

Release Notes Page 3 Concur Developer Platform Posted: Friday, April 3 2015 Concur Clients DRAFT Coming Soon: Travel Profile API Version 2.0 Overview The Travel Profile API is used to pass travel profile data from Concur to third parties, such as fulfillment TMCs and TripLink vendors. To expand the capabilities of the Travel Profile