Permalink
Browse files

Merge pull request #1271 from concur/preview

Documentation updates
  • Loading branch information...
bhague1281 committed Dec 7, 2017
2 parents 8f1dab1 + 0eea046 commit 3c157e771a45e0d0f633dc3abc0b7e34a32e30b7
@@ -602,7 +602,7 @@
},
"ProvincialTaxID": {
"type": "string",
"description": "The Vendor Provincial Tax ID."
"description": "The Vendor Provincial Tax ID. Note that this value is not encrypted at REST."
},
"PurchaseOrderContactEmail": {
"type": "string",
@@ -637,7 +637,7 @@
},
"TaxID": {
"type": "string",
"description": "The Vendor Tax ID."
"description": "The Vendor Tax ID. Note that this value is not encrypted at REST."
},
"TaxType": {
"type": "string",
@@ -23,6 +23,7 @@ If you are an existing partner with an existing app, please read both the [Migra
* [Client Credentials grant](#client_credentials)
* [One time password grant](#otp_grant)
* [Response Codes](#response_codes)
* [Troubleshooting](#troubleshooting)
**Note:** The old authentication documentation can be found [here](/api-reference-deprecated/old-auth/old-auth.html)
@@ -621,7 +622,8 @@ If the authorization or authentication are unsuccessful, your application will r
```Your_Redirect_Uri?
error_code=<>
&error_description=<>
```
```
In all cases, the friendly error description should be displayed to the user.
##### /token
@@ -693,3 +695,25 @@ In all cases, the friendly error description should be displayed to the user.
| 80 | `invalid_request` | invalid channel type |
| 81 | `invalid_request` | bad channel handle |
| 82 | `invalid_request` | the number of open otp requests has been exceeded |
## <a name="troubleshooting"></a>Troubleshooting
In order to assist with troubleshooting, Concur responds with a unique correlationId in the response header. The key to look for is `correlationid`. This unique code can be used during troubleshooting as it identifies the API call in the log files. You should record this information in your own API call logs as well so that you can pass this information on to the Concur support team.
Example of the `correlationid` in the response:
```
< HTTP/1.1 200 OK
< Server: cnqr-papeete
< Date: Mon, 04 Dec 2017 22:07:05 GMT
< Content-Type: application/json;charset=UTF-8
< Content-Length: 2897
< Connection: keep-alive
< Concur-Correlationid: 2803b8f8-a42b-43c2-a739-b8768e4759b8
```
@@ -19,12 +19,12 @@ Instructions for obtaining a Company Token is here : https://developer.concur.co
## <a name="usersbulk"></a>Calling /users Bulk API
Once you have the Company Token, you would call the `/users` endpoint to retrieve a list of users that belong to that company.
Once you have the Company Token, you would call the `/users/` endpoint to retrieve a list of users that belong to that company.
This endpoint will also return basic company information together with the list of users.
`GET /users`
`GET /users/`
**Query Parameters**
@@ -50,8 +50,8 @@ Sample Curl:
```shell
curl -v -X GET -H "Authorization: Bearer $token" \
-H "Accept: application/json"
'https://us.api.concursolutions.com/users?offset=0&limit=100&isactive=true'
-H "Accept: application/json" \
'https://us.api.concursolutions.com/users/?offset=0&limit=100&isactive=true'
```
successful call, responds with
@@ -7,6 +7,7 @@ layout: reference
# List of Scopes for all Concur APIs
* [Overview]()
* [Naming Conventions](#conventions)
* [List of v4 API Scopes](#v4apiscopes)
* [Old CONNECT API Scopes](#connectscopes)
@@ -16,6 +17,20 @@ Scopes apply to applications only. Scopes play a crucial part in defining the ul
`User’s Roles/permissions + Claims + App Scopes.`
## <a name="conventions"></a>Naming Conventions
Concur services follow these standard naming conventions for scopes.
`<resource>.<sub-resource>.<action>`
`<actions>` are defined by the type of API calls that can be made. These are the known lists of actions Concur honors.
| action | description |
| ---------- | ----------- |
| `.read` | Read only access (GET) |
| `.write` | Read AND Write access (GET, POST, UPDATE etc) |
| `.writeonly` | Write only access |
## <a name="v4apiscopes"></a>List of v4 API Scopes
These are the list of scopes for the new world v4+ APIs.
@@ -25,10 +25,11 @@ Message to reserve a hotel.
**HotelReservation**
| Element | Required | Data Type | Description |
|-----------|----------|-----------|-------------|
| RoomStays | Y | Complex | A reference to identify the booking. |
| ResGuests | Y | Complex | List of Guests. Concur only supports one guest. |
| Element | Required | Data Type | Description |
|---------------|----------|-----------|-------------|
| RoomStays | Y | Complex | A reference to identify the booking. |
| ResGuests | Y | Complex | List of Guests. Concur only supports one guest. |
| ResGlobalInfo | N | Complex | Contains various information that affects the Reservation as a whole, typically list of reward programs (see Memberships). |
**RoomStays**
@@ -163,6 +164,27 @@ Message to reserve a hotel.
| CompanyName | Y | StringLength1to32 | A string representing a customer's Company. |
**ResGlobalInfo**
| Element | Required | Data Type | Description |
|-------------|----------|-----------|-------------|
| Memberships | N | Complex | A collection of Memberships, provides a list of reward programs like e.g. loyalty cards. |
**Memberships**
| Element | Required | Data Type | Description |
|------------|----------|-----------|-------------|
| Membership | N | Complex | A recurring element that identifies the type of reward program and customer's identification number for this program. |
**Membership**
| Element | Required | Data Type | Description |
|---------------|----------|-------------------|-------------|
| *ProgramCode* | Y       | StringLength1to32 | The code or name of the reward program (e.g. "HotelLoyaltyProgram"). |
| *AccountID* | Y | StringLength1to64 | The account identification number for this particular member in this particular program. |
### TPA Extensions
@@ -124,6 +124,13 @@ The radius element is used along with the Hotel Preference to categorize the sea
| CountryName | N | Complex | Country name (e.g., Ireland) |
**StateProv**
| Element | Required | Data Type | Description |
|-----------|----------|------------------|-------------|
| StateCode | N | StringLength1to8 | The standard code or abbreviation for the state, province, or region (note the code may not be available for all states). |
**CountryName**
| Element | Required | Data Type | Description |
@@ -248,7 +248,7 @@ Name | Type | Format | Description
`PaymentMethodType`|`string`|-|Preferred Payment Type for Vendor.
`PaymentTerms`|`Integer between 1 and 999`|-|The Vendor Payment Terms. This field represents the number of days by which a payment must be made, for example, 30 days
`PostalCode`|`string`|-|The Vendor Postal Code / Zip.
`ProvincialTaxID`|`string`|-|The Vendor Provincial Tax ID.
`ProvincialTaxID`|`string`|-|The Vendor Provincial Tax ID. Note that this value is not encrypted at REST.
`PurchaseOrderContactEmail`|`string`|-|The Purchase Order Contact Email.
`PurchaseOrderContactFirstName`|`string`|-|The Purchase Order Contact First Name.
`PurchaseOrderContactLastName`|`string`|-|The Purchase Order Contact Last Name.
@@ -257,7 +257,7 @@ Name | Type | Format | Description
`ShippingTerms`|`string`|-|The Vendor Shipping Terms.
`State`|`string`|-|The Vendor State.
`StatusList`|`array`|[`Status`](#status)|**Required** Status results
`TaxID`|`string`|-|The Vendor Tax ID.
`TaxID`|`string`|-|The Vendor Tax ID. Note that this value is not encrypted at REST.
`TaxType`|`string`|-|The Vendor Tax Type.
`URI`|`string`|-|The URI to the resource.
`VendorBankList`|`array`|[`VendorBank`](#VendorBank)|The list of a vendor's active banking information. **Read-Only**

0 comments on commit 3c157e7

Please sign in to comment.