Permalink
Browse files

Merge pull request #1822 from concur/preview

Preview -> Livesite 2019-02-09
  • Loading branch information...
charlieconcur committed Feb 9, 2019
2 parents 9f8fd60 + 8be2ce1 commit da100df801f69aae4d56fa96aa3fbaaf3ec31fe9
@@ -0,0 +1,9 @@
---
title: GET Users Bulk API
layout: reference
reference-type: swagger
---



{% swagger /api-explorer/v3-1/BulkUser.swagger.json %}
@@ -0,0 +1,204 @@
{
"swagger": "2.0",
"info": {
"version": "3.1.0",
"title": "GET Users Bulk API",
"description": "This API takes a company level token, and returns a list of users that match the search criteria\n"
},
"host": "us.api.concursolutions.com",
"schemes": [
"https"
],
"paths": {
"/users/": {
"get": {
"parameters": [
{
"in": "header",
"name": "Authorization",
"type": "string",
"description": "Company level access Bearer token"
},
{
"in": "query",
"name": "offset",
"type": "integer",
"description": "The number of items to skip before returning result set"
},
{
"in": "query",
"name": "limit",
"type": "integer",
"description": "The numbers of items to return."
},
{
"in": "query",
"name": "isactive",
"type": "string",
"description": "Whether the user is active"
},
{
"in": "query",
"name": "loginid",
"type": "string",
"description": "login_id of the user"
},
{
"in": "query",
"name": "lastname",
"type": "string",
"description": "last name of the user"
},
{
"in": "query",
"name": "employeeid",
"type": "string",
"description": "Employee Id of the user"
},
{
"in": "query",
"name": "primaryemail",
"type": "string",
"description": "Primary email of the user"
},
{
"in": "query",
"name": "countrycode",
"type": "string",
"description": "Country Code of the user"
},
{
"in": "query",
"name": "id",
"type": "string",
"description": "Id of the user"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/Response"
}
},
"401": {
"description": "Authorization Required"
},
"404": {
"description": "Resoource not found"
}
}
}
}
},
"definitions": {
"User": {
"type": "object",
"properties": {
"ID": {
"type": "string",
"example": "99BFFFC3-C0BE-44FF-A441-AE1FFFFFF75B8"
},
"Active": {
"type": "boolean",
"example": true
},
"CountryCode": {
"type": "string",
"example": "US"
},
"CellPhoneNumber": {
"type": "string",
"example": "425-555-1111"
},
"PrimaryEmail": {
"type": "string",
"example": "johndoe@gmail.com"
},
"EmployeeID": {
"type": "string",
"example": "johndoe@gmail.com"
},
"OrganizationUnit": {
"type": "string",
"example": "IT"
},
"FirstName": {
"type": "string",
"example": "John"
},
"MiddleName": {
"type": "string",
"example": ""
},
"LastName": {
"type": "string",
"example": "Doe"
},
"LoginID": {
"type": "string",
"example": "johndoe@gmail.com"
},
"Emails": {
"type": "array",
"items": {
"type": "string",
"example": "johndoe@gmail.com"
}
}
}
},
"Response": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"example": 10
},
"offset": {
"type": "integer",
"example": 1
},
"limit": {
"type": 10,
"example": 10
},
"company": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Company Name LLC"
},
"address": {
"type": "string",
"example": "601 108th ave NE"
},
"city": {
"type": "string",
"example": "Bellevue"
},
"state": {
"type": "string",
"example": "WA"
},
"zip": {
"type": "string",
"example": "98004"
},
"country": {
"type": "string",
"example": "US"
}
}
},
"Items": {
"type": "array",
"items": {
"$ref": "#/definitions/User"
}
}
}
}
}
}
@@ -7,7 +7,7 @@ layout: reference

A basic expense with minimal fields. Can be added to expense reports from within SAP Concur.

> **Limitations**: This API is only available to partners who have been granted access by SAP Concur. Access to this documentation does not provide access to the API.
> **Limitations**: This API is only available to partners who have been granted access by SAP Concur. Access to this documentation does not provide access to the API. This API is not available in Implementation environments.
* [Products and Editions](#products-editions)
* [Scope Usage](#scope-usage)
@@ -52,6 +52,8 @@ The partner may use the following SAP Concur APIs to get optional information:
* [Expense Group Configurations v3.0](/api-reference/expense/expense-report/expense-group-configurations.html), to retrieve the `expenseTypeId`
* [Locations v3.0](/api-reference/common/locations/locations-resource.html), to retrieve the location `id`

**Japan Market**: If the partner is using this API to provide the e-Bunsho digital timestamp for the receipt, the partner should confirm that the client has e-Bunsho activated in SAP Concur.

## <a name="access-token-usage"></a>Access Token Usage

This API supports both company level and user level access tokens.
@@ -154,12 +154,22 @@ No.

## <a name="itin-best-practices"></a>Best Practices

* When extracting past data:
* When extracting past data:
* Extract a month of trip summaries to gauge volume. If hundreds are returned, then adjust extraction to weekly.
* Do not extract more than a year of data at any given time regardless of the volume. For longer look backs, extract 6 month segments maximum at a time.
* Do not multi-thread requests to retrieve multiple pages of data. Concurrent requests will impact your application’s performance.
* Itineraries change frequently. Changes do not necessarily indicate that the traveler modified their trip. If your application works with upcoming or in progress trips, be aware that you must evaluate the individual segments to determine whether it is a material change for your application.
* This API will only return itineraries that have been sent to Concur Travel; this includes travel booked within Concur Travel, TripIt, on TripLink supplier sites, and most bookings from your travel agency. Some customers may have multiple booking options which may mean not all employee trips are available via this API. A good rule of thumb: if the traveler sees the itinerary in their “trips” list, then you can retrieve it from this API.
* Do not extract more than a year of data at any given time regardless of the volume. For longer look backs, extract six month segments maximum at a time.
* Do not multi-thread requests to retrieve multiple pages of data. Concurrent requests will impact your application’s performance.
* This API will only return itineraries that have been sent to Concur Travel; this includes travel booked within Concur Travel, TripIt, on TripLink supplier sites, plans emailed to Concur, and most bookings from your travel agency.
* Some customers may have multiple booking options, which may mean not all employee trips are available via this API. A good rule of thumb: if the traveler sees the itinerary in their “trips” list, then you can retrieve it from this API.
* Because the data comes from many sources, data across itineraries may not be consistent. It’s recommended that you only consume the relevant segments and data (for example, air only or air + hotel) for your application’s function.
* Itineraries change frequently. Changes do not necessarily indicate that the traveler modified their trip. You should address relevant changes only. This may mean comparing what your application considers relevant (for example, trip dates) across updated itineraries. In addition:
* If your application works with upcoming or in progress trips, be aware that you must evaluate the individual segments to determine whether it is a material change for your application.
* If your app is consuming itineraries before the trip occurs, cancellations should be taken into account. To incorporate cancelled trips, set the `includeCancelledtrips` flag to “true” and leverage the trip status field to determine the application action.
* Your app should log key identifiers in addition to the `tripID`. It is recommended that “client locator” and user UUID be tracked so you can troubleshoot issues and match to data that customers have available.
* Many customers will opt-in to your integration for only a subset of their regions. It is recommended that you provide options, leveraging the user’s country in the travel profile, to determine which itineraries to extract.
* There are three different booking modes, all of which should be considered when building your application. Note that some clients additionally allow individuals to book for multiple passengers at a time.
* An individual booking for themselves.
* An individual booking on behalf of another user (profiled user).
* An individual booking for a guest (non-profiled user).

## <a name="reference-topics" id="reference-topics">Reference</a>

@@ -120,6 +120,7 @@ <h2>Marketing Support Meeting</h2>
</a>
</p>
<h2>Business Information Review Meeting</h2>
<p> NOTE: There will not be a meeting in March.</p>
<p>The Business Information Review meeting is held on the second Wednesday of every month at 9:00 am Pacific. The purpose of this meeting is to review all of the business aspects of going live in the App Center. We will discuss signing clients, notification forms, invoicing and support, plus many other topics. SAP Concur App Center recommends at least 1 person per Partner attend before “go live” in the App Center.</p>
<p>
<a class="btn white" href="https://concur.zoom.us/j/3545742473" target="_blank">

0 comments on commit da100df

Please sign in to comment.