Skip to content
This repository has been archived by the owner on Apr 29, 2022. It is now read-only.

Commit

Permalink
Merge pull request #2831 from concur/preview
Browse files Browse the repository at this point in the history
Preview -> livesite 2021-08-13
  • Loading branch information
jonikamelcher committed Aug 13, 2021
2 parents 9732fa2 + 52dffbe commit 354d448
Show file tree
Hide file tree
Showing 9 changed files with 91 additions and 106 deletions.
16 changes: 9 additions & 7 deletions src/_data/sidebars/api-explorer.yml
Original file line number Diff line number Diff line change
Expand Up @@ -81,20 +81,22 @@
- title: Expenses
url: /api-explorer/v4-0/Reports.html
- title: Financial Integration Service
url: /api-explorer/v4-0/FinancialIntegrationService.html
url: https://api.sap.com/api/ConcurFinancialIntegration/overview
- title: Identity
url: /api-explorer/v4-0/Identity.html
- title: Itinerary
url: /api-explorer/v4-0/Itinerary.html
- title: Invoice Pay
url: /api-explorer/v4-0/InvoicePay.html
url: https://api.sap.com/api/ConcurInvoicePay/overview
- title: List
url: /api-explorer/v4-0/List.html
url: https://api.sap.com/api/ConcurSharedLists/overview
- title: List Item
url: /api-explorer/v4-0/ListItem.html
url: https://api.sap.com/api/ConcurExpenseListItems/overview
- title: Purchase Requests
url: /api-explorer/v4-0/PurchaseRequest.html
url: https://api.sap.com/api/ConcurInvoicePurchaseRequest/overview
- title: Quick Expenses
url: /api-explorer/v4-0/QuickExpenses.html
url: https://api.sap.com/api/ConcurExpenseQuickExpenses/overview
- title: Reports
url: /api-explorer/v4-0/Reports.html
- title: Request
url: /api-explorer/v4-0/ConcurRequest.html
url: https://api.sap.com/api/ConcurRequestRequests/overview
10 changes: 6 additions & 4 deletions src/_data/sidebars/api-reference.yml
Original file line number Diff line number Diff line change
Expand Up @@ -250,14 +250,16 @@
children:
- title: Travel Services
url: /api-reference/travel/travel.html
- title: Itinerary API – Overview & Getting Started
- title: Itinerary v1 – Getting Started
url: /api-reference/travel/itinerary/itinerary.html
- title: Itinerary API Usage
- title: Itinerary v1 Usage
url: /api-reference/travel/itinerary-tmc-thirdparty/index.html
- title: Trip Endpoint
- title: Trip v1.1
url: /api-reference/travel/itinerary/trip/trip-resource.html
- title: Booking Endpoint
- title: Booking v1.1
url: /api-reference/travel/itinerary/booking/booking-resource.html
- title: Itinerary v4
url: /api-reference/travel/itinerary-v4/v4.itinerary.html
- title: User
url: ''
children:
Expand Down
2 changes: 2 additions & 0 deletions src/_data/sidebars/event-topics.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,5 @@
url: /event-topics/
- title: Concur Expense Event
url: /event-topics/expense/v4.expense-events.html
- title: Concur Itinerary Event
url: /event-topics/travel/v4.itinerary-events.html
6 changes: 6 additions & 0 deletions src/api-explorer/index.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ layout: reference

Browse [Swagger](https://swagger.io/) documents, such as what APIs are available, and their resource and method details.

## SAP API Hub

For v4 and newer APIs, you will be redirected to the [SAP API Hub](https://api.sap.com/products/SAPConcur/apis/REST). Over time the SAP API Hub will provide support for an improved Swagger experience as we make new APIs available.

Previous versions of APIs will continue to be displayed here.

## Base URIs

For information on Base URIs (also known as Instance URLs), including which URI to use, see [Base URIs](/platform/base-uris.html).
1 change: 1 addition & 0 deletions src/api-reference/authentication/app-center-learn-more.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ SUPSVC|Get supplier data|[Suppliers v3](/api-reference/common/suppliers/supplier
TAXINV|Get or validate digital tax invoices|[Sales Tax Validation v3](/api-reference/invoice/v3.sales-tax-validation.html)
TMCSP|TMC specific information|[Travel Profile v2 TMC](/api-reference/travel-profile/v2.profile-resource.html#General)
travelallowance.allowancedays.read|View the allowance days in an expense report|[Travel Allowance API](/api-reference/expense/travelallowance/travelallowance-days.html)
travel.itinerary.read|[Itinerary v4](/api-reference/travel/itinerary-v4/v4.itinerary.html)
travel.receipts.read|Read travel receipt requests|[Travel Receipts](/api-reference/travel-receipts/getting-started.html), [Travel Receipts Sample](/api-reference/travel-receipts/sample.html)
travel.receipts.write|Post travel receipts|[Travel Receipts](/api-reference/travel-receipts/getting-started.html), [Travel Receipts Sample](/api-reference/travel-receipts/sample.html)
travelrequest.write|Add, update, or delete travel requests|[Request v4](/api-reference/request/v4.get-started.html)
Expand Down
46 changes: 10 additions & 36 deletions src/api-reference/travel/itinerary-v4/v4.itinerary.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,10 @@ title: Itinerary v4
layout: reference
---

{% include prerelease.html %}
The Itinerary API provides clients and authorized partners access to travel itinerary data.

* [Overview](#overview)
* [Limitations](#limitations)
* [Prior Versions](#prior-versions)
* [Process Flow](#process-flow)
* [Products and Editions](#products-editions)
* [Scope Usage](#scope-usage)
Expand All @@ -15,13 +16,11 @@ layout: reference
* [Schemas](#schema)
* [Error Schema](#error-schema)

## <a name="overview"></a>Overview

The Itinerary API provides clients and authorized partners access to travel itinerary data.
## <a name="limitations"></a>Limitations

> **Limitations**: This API is only available to clients and partners who have been granted access by SAP Concur. Access to this documentation does not provide access to the API. This API is only available in US and EMEA data centers.
This API is only available to clients and partners who have been granted access by SAP Concur. Access to this documentation does not provide access to the API. This API is only available in US and EMEA data centers.

## Prior Versions
## <a name="prior-versions"></a>Prior Versions

* Itinerary v1 documentation is available [here](./api-reference/travel/itinerary/itinerary.html).

Expand Down Expand Up @@ -56,44 +55,19 @@ Retrieves the record of a trip.

`travel.itinerary.read` - Refer to [Scope Usage](#scope-usage) for full details.

### Request

#### URI

##### Template
### URI

```shell
GET https://{region}.api.concursolutions.com/travel/v4/trips/{id}
```

##### Parameters
### Parameters

Name|Type|Format|Description
---|---|---|---
`region`|`string`|-|**Required**: Region of the trip. Supported values: `us`, `eu`
`id`|`string`|-|**Required** The trip ID.

#### Headers

* [RFC 7231 Accept](https://tools.ietf.org/html/rfc7231#section-5.3.2)
* [RFC 7231 Accept-Encoding](https://tools.ietf.org/html/rfc7231#section-5.3.4)
* [RFC 7235 Authorization](https://tools.ietf.org/html/rfc7235#section-4.2)

### Response

#### Error Codes

* [400 Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)
* [401 Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)
* [403 Forbidden](https://tools.ietf.org/html/rfc7231#section-6.5.3)
* [404 Not Found](https://tools.ietf.org/html/rfc7231#section-6.5.4)
* [500 Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)


#### Payload

* [Error](#error-schema)

### Example

#### Request
Expand Down Expand Up @@ -1938,7 +1912,7 @@ Name|Type|Format|Description
`DataType`|`string`|-|The type of the custom attribute like numeric, string, etc.
`DisplayOnItinerary`|`boolean`|`true`/`false`|The condition that determines whether the attribute is displayed on the itinerary.
`DisplayTitle`|`string`|-|ignore this - this is the title of the custom attribute to display on the Concur-UI.
`ExternalId`|`integer`|-|THe internal reference to the definition of the custom attribute definition.
`ExternalId`|`integer`|-|The internal reference to the definition of the custom attribute definition.
`Name`|`string`|-|Work the Concur Travel Administrator for the company to get a list of configured custom trip attributes (known as Custom Trip Fields in the Concur documentation, not to be confused with Custom Profile fields). This is the name of the custom attribute configured by the admin.

### <a name="schema-frequent-traveler-program"></a>Frequent Traveler Program Element
Expand Down Expand Up @@ -1993,7 +1967,7 @@ Name|Type|Format|Description

Name|Type|Format|Description
---|---|---|---
`CompanyReasonCode`|`string`|-|Internal Only. The reason code congifured by the Travel Admin to identify the violation of policy for the booked trip
`CompanyReasonCode`|`string`|-|Internal Only. The reason code configured by the Travel Admin to identify the violation of policy for the booked trip
`CompanyRuleText`|`string`|-|Internal Only. The rule text configured by the Travel Admin.
`ViolationReasonCode`|`integer`|-|Internal Only. The integer identifier for the reason code selected when the user violates the rules/policy configured by the Travel Admin.

Expand Down
38 changes: 0 additions & 38 deletions src/tools-support/deprecation-policy-2021.markdown

This file was deleted.

31 changes: 31 additions & 0 deletions src/tools-support/deprecation-policy-legacy.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
title: API Lifecycle & Deprecation Policy
layout: reference
---

<div class="alert alert-danger">
<p><strong>This policy is no longer in effect.</strong></p>
<p>Deprecation Date: August 15, 2021</p>
<p>The current policy is available at: <a href="/tools-support/deprecation-policy.html">API Lifecycle & Deprecation Policy.</a></p>
</div>


The API Lifecycle & Deprecation Policy is part of our [API terms and conditions of use.](/Terms-of-Use.html) We may make periodic updates to this Policy, at which time we will notify those who have agreements with us.

## API Version Status

* **Active:** An active API version is the most current and fully supported API. It is the recommended version to use by everyone.
* **Deprecated:** A deprecated API version has been superseded by a newer API version. It is supported (bug fixes) for six months from the deprecation date. New apps will be denied access to deprecated APIs.
* **Retired:** A retired API version is no longer supported. It includes any API deprecated for more than six months. Any application using a retired API must migrate to an active API.
* **Decommissioned:** A decommissioned API version is no longer available on production. This occurs after three (3) months of inactivity in Retired state.

### API Version Status Table

Active | Deprecated | Retired | Decommissioned
-----|------|-------- | ------
**API is live in production.** | **API is live in production.** | API is live in production. | API is NOT available in production after three (3) months of inactivity in Retired status.
**Documentation*:** Available for review 2 weeks prior to launch; Posted day of launch. | **Documentation:** Deprecated status indicated and posted on day of deprecation. | **Documentation:** Retired status indicated and posted on day of retirement. | **Documentation:** n/a
**Support:** Updated with bug fixes and new features are available. | **Support:** Updated with bug fixes for first six (6) months; No fixes after that period. | **Support:** No longer supported six (6) months after Deprecated. | **Support:** None.
**Release Notes:** Notify 2 weeks prior to launch; Announce availability when in production. | **Release Notes:** Notify 90 days prior to deprecation; Announce when deprecated. | **Release Notes:** Notify 90 days prior to retirement; Announce when retired. | **Release Notes:** Notify 90 days prior to decommissioning.

## *Exception: Changes required due to security issues may have a shorter notification and action window.
47 changes: 26 additions & 21 deletions src/tools-support/deprecation-policy.markdown
Original file line number Diff line number Diff line change
@@ -1,29 +1,34 @@
---
title: API Lifecycle & Deprecation Policy
layout: reference

redirect_from:
- /tools-support/reference/deprecation-policy.html
---

# API Lifecycle & Deprecation Policy

The Concur API Lifecycle & Deprecation Policy is part of our [API terms and conditions of use.](/Terms-of-Use.html) We may make periodic updates to this Policy, at which time we will notify those who have agreements with us.
The API Lifecycle & Deprecation Policy is part of our [API terms and conditions of use.](/Terms-of-Use.html) We may make periodic updates to this policy, at which time we will notify those who have agreements with us.

## API Version Status

* **Active:** An active API version is the most current and fully supported API. It is the recommended version to use by everyone.
* **Deprecated:** A deprecated API version has been superseded by a newer API version. It is supported (bug fixes) for six months from the deprecation date. New apps will be denied access to deprecated APIs.
* **Retired:** A retired API version is no longer supported. It includes any API deprecated for more than six months. Any application using a retired API must migrate to an active API.
* **Decommissioned:** A decommissioned API version is no longer available on production. This occurs after three (3) months of inactivity in Retired state.

### API Version Status Table

Active | Deprecated | Retired | Decommissioned
-----|------|-------- | ------
**API is live in production.** | **API is live in production.** | API is live in production. | API is NOT available in production after three (3) months of inactivity in Retired status.
**Documentation*:** Available for review 2 weeks prior to launch; Posted day of launch. | **Documentation:** Deprecated status indicated and posted on day of deprecation. | **Documentation:** Retired status indicated and posted on day of retirement. | **Documentation:** n/a
**Support:** Updated with bug fixes and new features are available. | **Support:** Updated with bug fixes for first six (6) months; No fixes after that period. | **Support:** No longer supported six (6) months after Deprecated. | **Support:** None.
**Release Notes:** Notify 2 weeks prior to launch; Announce availability when in production. | **Release Notes:** Notify 90 days prior to deprecation; Announce when deprecated. | **Release Notes:** Notify 90 days prior to retirement; Announce when retired. | **Release Notes:** Notify 90 days prior to decommissioning.

## *Exception: Changes required due to security issues may have a shorter notification and action window.
* **Active:** An active API version is the most current and fully supported API. It is the recommended version for everyone to use.
* **Deprecated:** A deprecated API version has been superseded by a newer API version. New apps will be denied access to deprecated APIs.
* **Decommissioned:** A decommissioned API version is no longer available on production.

## API Lifespan and State Change

* **Minimum Lifespan:** We will provide a minimum lifespan for APIs of 24 months in the active or deprecated status before announcing a decommissioned state.
* **Deprecated -> Decommissioned:** Once an API transitions from an active to deprecated status, we will maintain the API in the deprecated state for a minimum of 12 months before transitioning the API to decommissioned state.
* **Decommissioned:** Decommissioned APIs are no longer supported and any and all documentation may be deleted at our discretion.
* **Exceptions:** There may be exceptions where we are not able to satisfy the foregoing minimum lifespan or minimum deprecated state duration. This is including but not limited to:
* Where required by law or regulatory authority.
* Where required by a third party licensor.
* To address a security risk.
* To address a claim by a third party of intellectual property infringement.
* Where the associated SAP Concur product has entered end of life.
* Where the API or the associated application have no adoption and are therefore being deleted.

## API Version Status Table

Active|Deprecated|Decommissioned
---|---|---
**API is live in production.**| **API is live in production.** | API is no longer available in production.
**Documentation:** Available for review two weeks prior to launch. Posted on day of launch. | **Documentation:** Deprecated status indicated and posted on day of deprecation. | **Documentation:** N/A
**Support:** Updated with bug fixes and new features are available. | **Support:** Updated with bug fixes for a minimum of 12 months. | **Support:** None.
**Release Notes:** Notify two weeks prior to launch. Announce availability when in production.| **Release Notes:** Notify 30 days prior to deprecation. Announce when deprecated. Time period is at least 12 months in this status. | **Release Notes:** Notify 30 days prior to decommissioning.

0 comments on commit 354d448

Please sign in to comment.