Status
This page represents version 1.0 of the Leap JSON Request specification. New versions of Leap JSON will always be backward compatible; using a never remove, only add strategy.
To request changes to the specification or report an error please contact support.
Request Format
This section describes the structure of a Leap JSON Request document, which is identified by the media-type: application/vnd.leap+json. Leap JSON documents are defined in JavaScript Object Notation (JSON). Conventions related to this document and definitions of client/server responsibilities related to Leap JSON are discussed in the Leap JSON introduction document.
Unless otherwise noted, objects defined by this specification should not contain any additional members. Client and server implementations must ignore members not recognized by this specification.
Top-level Reserved Property Names
A document MAY include the following attributes:
| Name | Type | Extra |
|---|---|---|
| apiVersion | String | Represents the desired version of the service API in a request and is expected to match the response version. |
| context | String | Echo-back data, set by the client and returned by the server. Used for asynchronous, batch, or pagination situations. |
| lang | String | ISO 639 language code for internationalization. |
| data | Object | Container Object for data parameters sent to the server from the client. |
| method | String | Specifies the operation to perform. |
Code Example
{
"apiVersion": "1.0",
"context": "contextString",
"lang": "en",
"data": {
"deliveryID": "12312312"
}
}