<commit_before>---
title: Service Name v1
layout: reference
---

{% include prerelease.html %}

Description of API, including business purpose and most common use case.

> **Limitations**: This section is optional. Which limitations the user may encounter, can include feature gaps from previous versions, limitations on access tokens, or support limitations for certain scenarios. If API only works in certain data centers, mention that here.

* [Process Flow](#process-flow)
* [Products and Editions](#products-editions)
* [Scope Usage](#scope-usage)
* [Dependencies](#dependencies)
* [Access Token Usage](#access-token-usage)
* [Create a resource](#create-resource)
* [Obtain a representation](#obtain-representation)
* [Schema](#schema)
  * [Schema One](#schema-one)
  * [Schema Two](#schema-two)
  * [Error](#schema-error)
* [Definitions](#definitions)

## <a name="process-flow"></a>Process Flow

A process diagram that explains the API structure and the usage flow from the user perspective, for the most common use case. Required by SAP. We have resources to make this diagram align with corporate styles, so we need only the basic details without any specific styling.

>insert sample diagram here

## <a name="products-editions"></a>Products and Editions

Delete any unsupported products or editions.

* Concur Expense Professional Edition
* Concur Expense Standard Edition
* Concur Travel Professional Edition
* Concur Travel Standard Edition
* Concur Invoice Professional Edition
* Concur Invoice Standard Edition
* Concur Request Professional Edition
* Concur Request Standard Edition

## <a name="scope-usage"></a>Scope Usage

Which scopes are required to interact with this API. This includes scopes for other APIs that are required (Company Profile, etc). Contact Scopes PM to add any new scopes to the repo.

Name|Description|Endpoint
---|---|---
`scope`|Description|endpoint that requires this scope

## <a name="dependencies"></a>Dependencies

Any other APIs that are required by the core process flow as documented in the diagram (Company Profile, User, List Item, other common APIs). Should include why they are required. Can include previous versions of this API if necessary.

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

List any company vs. user token differences for this specific API.

## <a name="create-resource"></a>Create a resource

Description for the endpoint here.

### Scopes

`customer.write` - Refer to [Scope Usage](#scope-usage) for full details.

### Request

#### URI

##### Template

```shell
https://{datacenterURI}/api/{storeIdentifier}?purchaseDate={purchaseDate}
```

##### Parameters

Name|Type|Format|Description
---|---|---|---
`storeIdentifier`|`string`|-|**Required** Note required when applicable.
`purchaseDate`|`string`|-|This parameter isn't required.

#### Headers

Delete unused headers

* [RFC 7231 Content-Type](https://tools.ietf.org/html/rfc7231#section-3.1.1.5)
* [RFC 7231 Content-Encoding](https://tools.ietf.org/html/rfc7231#section-3.1.2.2)
* [RFC 7231 Content-Language](https://tools.ietf.org/html/rfc7231#section-3.1.3.2)
* [RFC 7231 Content-Location](https://tools.ietf.org/html/rfc7231#section-3.1.4.2)
* [RFC 7230 Content-Length](https://tools.ietf.org/html/rfc7230#section-3.3.2)
* [RFC 7233 Content-Range](https://tools.ietf.org/html/rfc7233#section-4.2)
* [RFC 7230 Trailer](https://tools.ietf.org/html/rfc7230#section-4.4)
* [RFC 7230 Transfer-Encoding](https://tools.ietf.org/html/rfc7230#section-3.3.1)
* [RFC 7234 Cache-Control](https://tools.ietf.org/html/rfc7234#section-5.2)
* [RFC 7231 Expect](https://tools.ietf.org/html/rfc7231#section-5.1.1)
* [RFC 7230 Host](https://tools.ietf.org/html/rfc7230#section-5.4)
* [RFC 7231 Max-Forwards](https://tools.ietf.org/html/rfc7231#section-5.1.2)
* [RFC 7234 Pragma](https://tools.ietf.org/html/rfc7234#section-5.4)
* [RFC 7233 Range](https://tools.ietf.org/html/rfc7233#section-3.1)
* [RFC 7230 TE](https://tools.ietf.org/html/rfc7230#section-4.3)
* [RFC 7232 If-Match](https://tools.ietf.org/html/rfc7232#section-3.1)
* [RFC 7232 If-None-Match](https://tools.ietf.org/html/rfc7232#section-3.2)
* [RFC 7232 If-Modified-Since](https://tools.ietf.org/html/rfc7232#section-3.3)
* [RFC 7232 If-Unmodified-Since](https://tools.ietf.org/html/rfc7232#section-3.4)
* [RFC 7232 If-Range](https://tools.ietf.org/html/rfc7232#section-3.5)
* [RFC 7231 Accept](https://tools.ietf.org/html/rfc7231#section-5.3.2)
* [RFC 7231 Accept-Charset](https://tools.ietf.org/html/rfc7231#section-5.3.3)
* [RFC 7231 Accept-Encoding](https://tools.ietf.org/html/rfc7231#section-5.3.4)
* [RFC 7231 Accept-Language](https://tools.ietf.org/html/rfc7231#section-5.3.5)
* [RFC 7235 Authorization](https://tools.ietf.org/html/rfc7235#section-4.2)
* [RFC 7235 Proxy-Authorization](https://tools.ietf.org/html/rfc7235#section-4.4)
* [RFC 7231 From](https://tools.ietf.org/html/rfc7231#section-5.5.1)
* [RFC 7231 Referer](https://tools.ietf.org/html/rfc7231#section-5.5.2)
* [RFC 7231 User-Agent](https://tools.ietf.org/html/rfc7231#section-5.5.3)

#### Payload

* [Schema One](#schema-one)

### Response

#### Status Codes

Delete unused codes

* [100 Continue](https://tools.ietf.org/html/rfc7231#section-6.2.1)
* [101 Switching Protocols](https://tools.ietf.org/html/rfc7231#section-6.2.2)
* [102 Processing](https://tools.ietf.org/html/rfc2518#section-10.1)
* [200 OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)
* [201 Created](https://tools.ietf.org/html/rfc7231#section-6.3.2)
* [202 Accepted](https://tools.ietf.org/html/rfc7231#section-6.3.3)
* [203 Non-Authoritative Information](https://tools.ietf.org/html/rfc7231#section-6.3.4)
* [204 No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)
* [205 Reset Content](https://tools.ietf.org/html/rfc7231#section-6.3.6)
* [206 Partial Content](https://tools.ietf.org/html/rfc7233#section-4.1)
* [207 Multi-Status](https://tools.ietf.org/html/rfc4918#section-11.1)
* [208 Already Reported](https://tools.ietf.org/html/rfc5842#section-7.1)
* [226 IM Used](https://tools.ietf.org/html/rfc3229#section-10.4.1)
* [300 Multiple Choices](https://tools.ietf.org/html/rfc7231#section-6.4.1)
* [301 Moved Permanently](https://tools.ietf.org/html/rfc7231#section-6.4.2)
* [302 Found](https://tools.ietf.org/html/rfc7231#section-6.4.3)
* [303 See Other](https://tools.ietf.org/html/rfc7231#section-6.4.4)
* [304 Not Modified](https://tools.ietf.org/html/rfc7232#section-4.1)
* [305 Use Proxy](https://tools.ietf.org/html/rfc7231#section-6.4.5)
* [307 Temporary Redirect](https://tools.ietf.org/html/rfc7231#section-6.4.7)
* [308 Permanent Redirect](https://tools.ietf.org/html/rfc7538#section-3)
* [400 Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)
* [401 Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)
* [402 Payment Required](https://tools.ietf.org/html/rfc7231#section-6.5.2)
* [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)
* [405 Method Not Allowed](https://tools.ietf.org/html/rfc7231#section-6.5.5)
* [406 Not Acceptable](https://tools.ietf.org/html/rfc7231#section-6.5.6)
* [407 Proxy Authentication Required](https://tools.ietf.org/html/rfc7235#section-3.2)
* [408 Request Timeout](https://tools.ietf.org/html/rfc7231#section-6.5.7)
* [409 Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)
* [410 Gone](https://tools.ietf.org/html/rfc7231#section-6.5.9)
* [411 Length Required](https://tools.ietf.org/html/rfc7231#section-6.5.10)
* [412 Precondition Failed](https://tools.ietf.org/html/rfc7232#section-4.2)
* [413 Payload Too Large](https://tools.ietf.org/html/rfc7231#section-6.5.11)
* [414 URI Too Long](https://tools.ietf.org/html/rfc7231#section-6.5.12)
* [415 Unsupported Media Type](https://tools.ietf.org/html/rfc7231#section-6.5.13)
* [416 Range Not Satisfiable](https://tools.ietf.org/html/rfc7233#section-4.4)
* [417 Expectation Failed](https://tools.ietf.org/html/rfc7231#section-6.5.14)
* [421 Misdirected Request](https://tools.ietf.org/html/rfc7540#section-9.1.2)
* [422 Unprocessable Entity](https://tools.ietf.org/html/rfc4918#section-11.2)
* [423 Locked](https://tools.ietf.org/html/rfc4918#section-11.3)
* [424 Failed Dependency](https://tools.ietf.org/html/rfc4918#section-11.4)
* [426 Upgrade Required](https://tools.ietf.org/html/rfc7231#section-6.5.15)
* [428 Precondition Required](https://tools.ietf.org/html/rfc6585#section-3)
* [429 Too Many Requests](https://tools.ietf.org/html/rfc6585#section-4)
* [431 Request Header Fields Too Large](https://tools.ietf.org/html/rfc6585#section-5)
* [451 Unavailable For Legal Reasons](https://tools.ietf.org/html/rfc7725#section-3)
* [500 Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)
* [501 Not Implemented](https://tools.ietf.org/html/rfc7231#section-6.6.2)
* [502 Bad Gateway](https://tools.ietf.org/html/rfc7231#section-6.6.3)
* [503 Service Unavailable](https://tools.ietf.org/html/rfc7231#section-6.6.4)
* [504 Gateway Timeout](https://tools.ietf.org/html/rfc7231#section-6.6.5)
* [505 HTTP Version Not Supported](https://tools.ietf.org/html/rfc7231#section-6.6.6)
* [506 Variant Also Negotiates](https://tools.ietf.org/html/rfc2295#section-8.1)
* [507 Insufficient Storage](https://tools.ietf.org/html/rfc4918#section-11.5)
* [508 Loop Detected](https://tools.ietf.org/html/rfc5842#section-7.2)
* [510 Not Extended](https://tools.ietf.org/html/rfc2774#section-7)
* [511 Network Authentication Required](https://tools.ietf.org/html/rfc6585#section-6)

#### Headers

Delete unused headers

* `concur-correlationid` is a Concur specific custom header used for technical support in the form of a [RFC 4122 A Universally Unique IDentifier (UUID) URN Namespace](https://tools.ietf.org/html/rfc4122)
* [RFC 7231 Content-Type](https://tools.ietf.org/html/rfc7231#section-3.1.1.5)
* [RFC 7231 Content-Encoding](https://tools.ietf.org/html/rfc7231#section-3.1.2.2)
* [RFC 7231 Content-Language](https://tools.ietf.org/html/rfc7231#section-3.1.3.2)
* [RFC 7231 Content-Location](https://tools.ietf.org/html/rfc7231#section-3.1.4.2)
* [RFC 7230 Content-Length](https://tools.ietf.org/html/rfc7230#section-3.3.2)
* [RFC 7233 Content-Range](https://tools.ietf.org/html/rfc7233#section-4.2)
* [RFC 7230 Trailer](https://tools.ietf.org/html/rfc7230#section-4.4)
* [RFC 7230 Transfer-Encoding](https://tools.ietf.org/html/rfc7230#section-3.3.1)
* [RFC 7231 Content-Type](https://tools.ietf.org/html/rfc7231#section-3.1.1.5)
* [RFC 7234 Age](https://tools.ietf.org/html/rfc7234#section-5.1)
* [RFC 7234 Cache-Control](https://tools.ietf.org/html/rfc7234#section-5.2)
* [RFC 7234 Expires](https://tools.ietf.org/html/rfc7234#section-5.3)
* [RFC 7231 Date](https://tools.ietf.org/html/rfc7231#section-7.1.1.2)
* [RFC 7231 Location](https://tools.ietf.org/html/rfc7231#section-7.1.2)
* [RFC 7231 Retry-After](https://tools.ietf.org/html/rfc7231#section-7.1.3)
* [RFC 7231 Vary](https://tools.ietf.org/html/rfc7231#section-7.1.4)
* [RFC 7234 Warning](https://tools.ietf.org/html/rfc7234#section-5.5)
* [RFC 7232 ETag](https://tools.ietf.org/html/rfc7232#section-2.3)
* [RFC 7232 Last-Modified](https://tools.ietf.org/html/rfc7232#section-2.2)
* [RFC 7235 WWW-Authenticate](https://tools.ietf.org/html/rfc7235#section-4.1)
* [RFC 7235 Proxy-Authenticate](https://tools.ietf.org/html/rfc7235#section-4.3)
* [RFC 7233 Accept-Ranges](https://tools.ietf.org/html/rfc7233#section-2.3)
* [RFC 7231 Allow](https://tools.ietf.org/html/rfc7231#section-7.4.1)
* [RFC 7231 Server](https://tools.ietf.org/html/rfc7231#section-7.4.2)

#### Payload

* [Schema One](#schema-one)
* [Error](#schema-error)

### Example

#### Request

* Showing developers exactly what they can expect in request and response values when using is perhaps the simplest way to complete this portion of the documentation.
* Use triple backticks to create fenced code blocks and a language identifier for syntax highlighting.
* See [Creating and highlighting code blocks](https://help.github.com/articles/creating-and-highlighting-code-blocks/)

```shell
POST https://example.com/stores/123
Accept: application/json
```

```json
{
  "orderId": "value",
  "orderMemo": "value"
}
```

#### Response

* Ensure the headers are kept separate as a code block from the payload for ease of reading.
* Add the language identifier to any code blocks for syntax highlighting
* See the GitHub topic [Creating and highlighting code blocks](https://help.github.com/articles/creating-and-highlighting-code-blocks/) for more information.

```shell
HTTP/1.1 200 OK
Cache-Control: max-age=604800
Content-Type: application/json
Date: Wed, 06 Jul 2020 17:33:03 GMT
Etag: "359670651"
Expires: Wed, 13 Jul 2020 17:33:03 GMT
Last-Modified: Fri, 09 Aug 2020 23:54:35 GMT
Content-Length: 1270
```

```json
{
  "orderId": "value",
  "orderMemo": "value",
  "transactionTimestamp": "Wed, 01 Jan 2020 12:00:00 GMT",
  "arrayOfThings": [
    {
      "orderDetailsId": "value",
      "aKeyForEnum": 1
    }
  ]
}
```

## <a name="obtain-representation"></a>Obtain a representation

Copy, paste and modify the template found in the [Create a resource](#create-resource) section.

## <a name="schema"></a>Schema

### <a name="schema-one"></a>Schema One

Name|Type|Format|Description
---|---|---|---
`orderId`|`string`|-|**Required** A description including required status.
`orderMemo`|`string`|-|A description. This key is not required.
`transactionTimestamp`|`string`|[dateTime](#definition-dateTime)|A key linking to a definition for the format.
`arrayOfThings`|`array`|[Schema Two](#schema-two)|A key linking to another schema for the format.

### <a name="schema-two"></a>Schema Two

Name|Type|Format|Description
---|---|---|---
`orderDetailsId`|`string`|-|A description for the key.
`aKeyForEnum`|`number`|`enum`|The value must be one of these: `1`, `2` or `3`.

### <a name="schema-error"></a>Error

Name|Type|Format|Description
---|---|---|---
`errorCode`|`string`|-|**Required** Machine readable code associated with the error which is static and never localized. Examples: `dateTimeMissing`, `OutOfMem` and `invalidUser`. These could also be UUID4 (`a1d7bb3bb19348b0858687acc9e303ec`), number (`123456`) or a URI (`https://example.com/errors/invaliduser`) which ideally provides additional information when dereferenced. Whatever form is chosen it's worth noting contextual strings are helpful to developers reading the code.
`errorMessage`|`string`|-|**Required** Message associated with the error.
`dataPath`|`string`|-|Relative data path.
`schemaPath`|`string`|-|Relative schema path.
`errors`|`array`|[`error`](#schema-error)|An array of errors. Note: this points to this schema as errors can nest.

## <a name="definitions"></a>Definitions

Name|Type|Format|Description
---|---|---|---
<a name="definition-dateTime"></a>`dateTime`|`string`|-|DateTime of where the transaction happened in format specified in ISO 8601, using UTC + Offset. For example, 2016-04-22T12:20+0700 (12:20 PM in Pacific Time).
<commit_msg>Updating limtations per RoAnn.<commit_after>---
title: Service Name v1
layout: reference
---

{% include prerelease.html %}

Description of API, including business purpose and most common use case.

> **Limitations**: This section is optional. Which limitations the user may encounter, can include feature gaps from previous versions, limitations on access tokens, any rate limits or rate throttling, or support limitations for certain scenarios. If API only works in certain data centers, mention that here.

* [Process Flow](#process-flow)
* [Products and Editions](#products-editions)
* [Scope Usage](#scope-usage)
* [Dependencies](#dependencies)
* [Access Token Usage](#access-token-usage)
* [Create a resource](#create-resource)
* [Obtain a representation](#obtain-representation)
* [Schema](#schema)
  * [Schema One](#schema-one)
  * [Schema Two](#schema-two)
  * [Error](#schema-error)
* [Definitions](#definitions)

## <a name="process-flow"></a>Process Flow

A process diagram that explains the API structure and the usage flow from the user perspective, for the most common use case. Required by SAP. We have resources to make this diagram align with corporate styles, so we need only the basic details without any specific styling.

>insert sample diagram here

## <a name="products-editions"></a>Products and Editions

Delete any unsupported products or editions.

* Concur Expense Professional Edition
* Concur Expense Standard Edition
* Concur Travel Professional Edition
* Concur Travel Standard Edition
* Concur Invoice Professional Edition
* Concur Invoice Standard Edition
* Concur Request Professional Edition
* Concur Request Standard Edition

## <a name="scope-usage"></a>Scope Usage

Which scopes are required to interact with this API. This includes scopes for other APIs that are required (Company Profile, etc). Contact Scopes PM to add any new scopes to the repo.

Name|Description|Endpoint
---|---|---
`scope`|Description|endpoint that requires this scope

## <a name="dependencies"></a>Dependencies

Any other APIs that are required by the core process flow as documented in the diagram (Company Profile, User, List Item, other common APIs). Should include why they are required. Can include previous versions of this API if necessary.

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

List any company vs. user token differences for this specific API.

## <a name="create-resource"></a>Create a resource

Description for the endpoint here.

### Scopes

`customer.write` - Refer to [Scope Usage](#scope-usage) for full details.

### Request

#### URI

##### Template

```shell
https://{datacenterURI}/api/{storeIdentifier}?purchaseDate={purchaseDate}
```

##### Parameters

Name|Type|Format|Description
---|---|---|---
`storeIdentifier`|`string`|-|**Required** Note required when applicable.
`purchaseDate`|`string`|-|This parameter isn't required.

#### Headers

Delete unused headers

* [RFC 7231 Content-Type](https://tools.ietf.org/html/rfc7231#section-3.1.1.5)
* [RFC 7231 Content-Encoding](https://tools.ietf.org/html/rfc7231#section-3.1.2.2)
* [RFC 7231 Content-Language](https://tools.ietf.org/html/rfc7231#section-3.1.3.2)
* [RFC 7231 Content-Location](https://tools.ietf.org/html/rfc7231#section-3.1.4.2)
* [RFC 7230 Content-Length](https://tools.ietf.org/html/rfc7230#section-3.3.2)
* [RFC 7233 Content-Range](https://tools.ietf.org/html/rfc7233#section-4.2)
* [RFC 7230 Trailer](https://tools.ietf.org/html/rfc7230#section-4.4)
* [RFC 7230 Transfer-Encoding](https://tools.ietf.org/html/rfc7230#section-3.3.1)
* [RFC 7234 Cache-Control](https://tools.ietf.org/html/rfc7234#section-5.2)
* [RFC 7231 Expect](https://tools.ietf.org/html/rfc7231#section-5.1.1)
* [RFC 7230 Host](https://tools.ietf.org/html/rfc7230#section-5.4)
* [RFC 7231 Max-Forwards](https://tools.ietf.org/html/rfc7231#section-5.1.2)
* [RFC 7234 Pragma](https://tools.ietf.org/html/rfc7234#section-5.4)
* [RFC 7233 Range](https://tools.ietf.org/html/rfc7233#section-3.1)
* [RFC 7230 TE](https://tools.ietf.org/html/rfc7230#section-4.3)
* [RFC 7232 If-Match](https://tools.ietf.org/html/rfc7232#section-3.1)
* [RFC 7232 If-None-Match](https://tools.ietf.org/html/rfc7232#section-3.2)
* [RFC 7232 If-Modified-Since](https://tools.ietf.org/html/rfc7232#section-3.3)
* [RFC 7232 If-Unmodified-Since](https://tools.ietf.org/html/rfc7232#section-3.4)
* [RFC 7232 If-Range](https://tools.ietf.org/html/rfc7232#section-3.5)
* [RFC 7231 Accept](https://tools.ietf.org/html/rfc7231#section-5.3.2)
* [RFC 7231 Accept-Charset](https://tools.ietf.org/html/rfc7231#section-5.3.3)
* [RFC 7231 Accept-Encoding](https://tools.ietf.org/html/rfc7231#section-5.3.4)
* [RFC 7231 Accept-Language](https://tools.ietf.org/html/rfc7231#section-5.3.5)
* [RFC 7235 Authorization](https://tools.ietf.org/html/rfc7235#section-4.2)
* [RFC 7235 Proxy-Authorization](https://tools.ietf.org/html/rfc7235#section-4.4)
* [RFC 7231 From](https://tools.ietf.org/html/rfc7231#section-5.5.1)
* [RFC 7231 Referer](https://tools.ietf.org/html/rfc7231#section-5.5.2)
* [RFC 7231 User-Agent](https://tools.ietf.org/html/rfc7231#section-5.5.3)

#### Payload

* [Schema One](#schema-one)

### Response

#### Status Codes

Delete unused codes

* [100 Continue](https://tools.ietf.org/html/rfc7231#section-6.2.1)
* [101 Switching Protocols](https://tools.ietf.org/html/rfc7231#section-6.2.2)
* [102 Processing](https://tools.ietf.org/html/rfc2518#section-10.1)
* [200 OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)
* [201 Created](https://tools.ietf.org/html/rfc7231#section-6.3.2)
* [202 Accepted](https://tools.ietf.org/html/rfc7231#section-6.3.3)
* [203 Non-Authoritative Information](https://tools.ietf.org/html/rfc7231#section-6.3.4)
* [204 No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5)
* [205 Reset Content](https://tools.ietf.org/html/rfc7231#section-6.3.6)
* [206 Partial Content](https://tools.ietf.org/html/rfc7233#section-4.1)
* [207 Multi-Status](https://tools.ietf.org/html/rfc4918#section-11.1)
* [208 Already Reported](https://tools.ietf.org/html/rfc5842#section-7.1)
* [226 IM Used](https://tools.ietf.org/html/rfc3229#section-10.4.1)
* [300 Multiple Choices](https://tools.ietf.org/html/rfc7231#section-6.4.1)
* [301 Moved Permanently](https://tools.ietf.org/html/rfc7231#section-6.4.2)
* [302 Found](https://tools.ietf.org/html/rfc7231#section-6.4.3)
* [303 See Other](https://tools.ietf.org/html/rfc7231#section-6.4.4)
* [304 Not Modified](https://tools.ietf.org/html/rfc7232#section-4.1)
* [305 Use Proxy](https://tools.ietf.org/html/rfc7231#section-6.4.5)
* [307 Temporary Redirect](https://tools.ietf.org/html/rfc7231#section-6.4.7)
* [308 Permanent Redirect](https://tools.ietf.org/html/rfc7538#section-3)
* [400 Bad Request](https://tools.ietf.org/html/rfc7231#section-6.5.1)
* [401 Unauthorized](https://tools.ietf.org/html/rfc7235#section-3.1)
* [402 Payment Required](https://tools.ietf.org/html/rfc7231#section-6.5.2)
* [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)
* [405 Method Not Allowed](https://tools.ietf.org/html/rfc7231#section-6.5.5)
* [406 Not Acceptable](https://tools.ietf.org/html/rfc7231#section-6.5.6)
* [407 Proxy Authentication Required](https://tools.ietf.org/html/rfc7235#section-3.2)
* [408 Request Timeout](https://tools.ietf.org/html/rfc7231#section-6.5.7)
* [409 Conflict](https://tools.ietf.org/html/rfc7231#section-6.5.8)
* [410 Gone](https://tools.ietf.org/html/rfc7231#section-6.5.9)
* [411 Length Required](https://tools.ietf.org/html/rfc7231#section-6.5.10)
* [412 Precondition Failed](https://tools.ietf.org/html/rfc7232#section-4.2)
* [413 Payload Too Large](https://tools.ietf.org/html/rfc7231#section-6.5.11)
* [414 URI Too Long](https://tools.ietf.org/html/rfc7231#section-6.5.12)
* [415 Unsupported Media Type](https://tools.ietf.org/html/rfc7231#section-6.5.13)
* [416 Range Not Satisfiable](https://tools.ietf.org/html/rfc7233#section-4.4)
* [417 Expectation Failed](https://tools.ietf.org/html/rfc7231#section-6.5.14)
* [421 Misdirected Request](https://tools.ietf.org/html/rfc7540#section-9.1.2)
* [422 Unprocessable Entity](https://tools.ietf.org/html/rfc4918#section-11.2)
* [423 Locked](https://tools.ietf.org/html/rfc4918#section-11.3)
* [424 Failed Dependency](https://tools.ietf.org/html/rfc4918#section-11.4)
* [426 Upgrade Required](https://tools.ietf.org/html/rfc7231#section-6.5.15)
* [428 Precondition Required](https://tools.ietf.org/html/rfc6585#section-3)
* [429 Too Many Requests](https://tools.ietf.org/html/rfc6585#section-4)
* [431 Request Header Fields Too Large](https://tools.ietf.org/html/rfc6585#section-5)
* [451 Unavailable For Legal Reasons](https://tools.ietf.org/html/rfc7725#section-3)
* [500 Internal Server Error](https://tools.ietf.org/html/rfc7231#section-6.6.1)
* [501 Not Implemented](https://tools.ietf.org/html/rfc7231#section-6.6.2)
* [502 Bad Gateway](https://tools.ietf.org/html/rfc7231#section-6.6.3)
* [503 Service Unavailable](https://tools.ietf.org/html/rfc7231#section-6.6.4)
* [504 Gateway Timeout](https://tools.ietf.org/html/rfc7231#section-6.6.5)
* [505 HTTP Version Not Supported](https://tools.ietf.org/html/rfc7231#section-6.6.6)
* [506 Variant Also Negotiates](https://tools.ietf.org/html/rfc2295#section-8.1)
* [507 Insufficient Storage](https://tools.ietf.org/html/rfc4918#section-11.5)
* [508 Loop Detected](https://tools.ietf.org/html/rfc5842#section-7.2)
* [510 Not Extended](https://tools.ietf.org/html/rfc2774#section-7)
* [511 Network Authentication Required](https://tools.ietf.org/html/rfc6585#section-6)

#### Headers

Delete unused headers

* `concur-correlationid` is a Concur specific custom header used for technical support in the form of a [RFC 4122 A Universally Unique IDentifier (UUID) URN Namespace](https://tools.ietf.org/html/rfc4122)
* [RFC 7231 Content-Type](https://tools.ietf.org/html/rfc7231#section-3.1.1.5)
* [RFC 7231 Content-Encoding](https://tools.ietf.org/html/rfc7231#section-3.1.2.2)
* [RFC 7231 Content-Language](https://tools.ietf.org/html/rfc7231#section-3.1.3.2)
* [RFC 7231 Content-Location](https://tools.ietf.org/html/rfc7231#section-3.1.4.2)
* [RFC 7230 Content-Length](https://tools.ietf.org/html/rfc7230#section-3.3.2)
* [RFC 7233 Content-Range](https://tools.ietf.org/html/rfc7233#section-4.2)
* [RFC 7230 Trailer](https://tools.ietf.org/html/rfc7230#section-4.4)
* [RFC 7230 Transfer-Encoding](https://tools.ietf.org/html/rfc7230#section-3.3.1)
* [RFC 7231 Content-Type](https://tools.ietf.org/html/rfc7231#section-3.1.1.5)
* [RFC 7234 Age](https://tools.ietf.org/html/rfc7234#section-5.1)
* [RFC 7234 Cache-Control](https://tools.ietf.org/html/rfc7234#section-5.2)
* [RFC 7234 Expires](https://tools.ietf.org/html/rfc7234#section-5.3)
* [RFC 7231 Date](https://tools.ietf.org/html/rfc7231#section-7.1.1.2)
* [RFC 7231 Location](https://tools.ietf.org/html/rfc7231#section-7.1.2)
* [RFC 7231 Retry-After](https://tools.ietf.org/html/rfc7231#section-7.1.3)
* [RFC 7231 Vary](https://tools.ietf.org/html/rfc7231#section-7.1.4)
* [RFC 7234 Warning](https://tools.ietf.org/html/rfc7234#section-5.5)
* [RFC 7232 ETag](https://tools.ietf.org/html/rfc7232#section-2.3)
* [RFC 7232 Last-Modified](https://tools.ietf.org/html/rfc7232#section-2.2)
* [RFC 7235 WWW-Authenticate](https://tools.ietf.org/html/rfc7235#section-4.1)
* [RFC 7235 Proxy-Authenticate](https://tools.ietf.org/html/rfc7235#section-4.3)
* [RFC 7233 Accept-Ranges](https://tools.ietf.org/html/rfc7233#section-2.3)
* [RFC 7231 Allow](https://tools.ietf.org/html/rfc7231#section-7.4.1)
* [RFC 7231 Server](https://tools.ietf.org/html/rfc7231#section-7.4.2)

#### Payload

* [Schema One](#schema-one)
* [Error](#schema-error)

### Example

#### Request

* Showing developers exactly what they can expect in request and response values when using is perhaps the simplest way to complete this portion of the documentation.
* Use triple backticks to create fenced code blocks and a language identifier for syntax highlighting.
* See [Creating and highlighting code blocks](https://help.github.com/articles/creating-and-highlighting-code-blocks/)

```shell
POST https://example.com/stores/123
Accept: application/json
```

```json
{
  "orderId": "value",
  "orderMemo": "value"
}
```

#### Response

* Ensure the headers are kept separate as a code block from the payload for ease of reading.
* Add the language identifier to any code blocks for syntax highlighting
* See the GitHub topic [Creating and highlighting code blocks](https://help.github.com/articles/creating-and-highlighting-code-blocks/) for more information.

```shell
HTTP/1.1 200 OK
Cache-Control: max-age=604800
Content-Type: application/json
Date: Wed, 06 Jul 2020 17:33:03 GMT
Etag: "359670651"
Expires: Wed, 13 Jul 2020 17:33:03 GMT
Last-Modified: Fri, 09 Aug 2020 23:54:35 GMT
Content-Length: 1270
```

```json
{
  "orderId": "value",
  "orderMemo": "value",
  "transactionTimestamp": "Wed, 01 Jan 2020 12:00:00 GMT",
  "arrayOfThings": [
    {
      "orderDetailsId": "value",
      "aKeyForEnum": 1
    }
  ]
}
```

## <a name="obtain-representation"></a>Obtain a representation

Copy, paste and modify the template found in the [Create a resource](#create-resource) section.

## <a name="schema"></a>Schema

### <a name="schema-one"></a>Schema One

Name|Type|Format|Description
---|---|---|---
`orderId`|`string`|-|**Required** A description including required status.
`orderMemo`|`string`|-|A description. This key is not required.
`transactionTimestamp`|`string`|[dateTime](#definition-dateTime)|A key linking to a definition for the format.
`arrayOfThings`|`array`|[Schema Two](#schema-two)|A key linking to another schema for the format.

### <a name="schema-two"></a>Schema Two

Name|Type|Format|Description
---|---|---|---
`orderDetailsId`|`string`|-|A description for the key.
`aKeyForEnum`|`number`|`enum`|The value must be one of these: `1`, `2` or `3`.

### <a name="schema-error"></a>Error

Name|Type|Format|Description
---|---|---|---
`errorCode`|`string`|-|**Required** Machine readable code associated with the error which is static and never localized. Examples: `dateTimeMissing`, `OutOfMem` and `invalidUser`. These could also be UUID4 (`a1d7bb3bb19348b0858687acc9e303ec`), number (`123456`) or a URI (`https://example.com/errors/invaliduser`) which ideally provides additional information when dereferenced. Whatever form is chosen it's worth noting contextual strings are helpful to developers reading the code.
`errorMessage`|`string`|-|**Required** Message associated with the error.
`dataPath`|`string`|-|Relative data path.
`schemaPath`|`string`|-|Relative schema path.
`errors`|`array`|[`error`](#schema-error)|An array of errors. Note: this points to this schema as errors can nest.

## <a name="definitions"></a>Definitions

Name|Type|Format|Description
---|---|---|---
<a name="definition-dateTime"></a>`dateTime`|`string`|-|DateTime of where the transaction happened in format specified in ISO 8601, using UTC + Offset. For example, 2016-04-22T12:20+0700 (12:20 PM in Pacific Time).

{'fraction_non_alphanumeric': 0.1777807282504066, 'fraction_numerical': 0.08497361171042586, 'mean_word_length': 4.883225932435071, 'pattern_counts': {'":': 16, '<': 55, '<?xml version=': 0, '>': 59, 'https://': 236, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 20, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2622196', 'n_tokens_mistral': 12421, 'n_tokens_neox': 10955, 'n_words': 2073}