/manifest/{seasonCode}/{facilityCode}/{configurationCode}
Description
The manifest endpoint returns information for the requested facility configuration. Only those seats included in the facility configuration are returned.
- Areas are returned in the order in which they are assembled within a configuration.
- Sections are returned in level/section order, as they are assembled within a configuration.
- Rows are returned in row allocation order, as they are listed within the season's facility manifest.
- Seats are returned in seat index order, as they are listed within the season's facility manifest.
- Calling with method
HEADwill return aLast-Modifiedheader. Use this to keep track of the date; If the date changes, call again withGETto get the updated data.
Supported Methods
- HEAD
- GET
Supported Media Types
Request
- application/json
Response
- application/json
Request
/manifest/{seasonCode}/{facilityCode}/{configurationCode}
HEADERS
| RCO | Multitude | Key | Type | Description |
|---|---|---|---|---|
| R | 1 | User-Agent | String | An identifying string in Product/Version format, where Version is a SemVer-compliant string, that uniquely identifies your application. |
| R | 1 | Authorization | String | It's required to use the "Bearer" authentication scheme to transmit the access token. |
| R | 1 | Accept | String | The only supported response type for this endpoint is application/json. |
| O | 0-1 | Accept-Encoding | String | gzip compression is supported. |
| R | 1 | Content-Type | String | The only supported request type for this endpoint is application/json. |
| R | 1 | PAC-Application-ID | String | The application identifier for which API access has been authorized; this value is typically expressed in reverse domain notation and is bound to an API key provided by Paciolan during provisioning. |
| R | 1 | PAC-API-Key | String | The API key provided by Paciolan for this application. |
| R | 1 | PAC-Channel-Code | String | The channel partner identifier issued to your organization by the Paciolan Partner Services team partner on-boarding. |
| R | 1 | Request-ID | String | The integrator's external request ID for support traceablility and issue debugging. This string should be a UUID V4 value. |
| R | 1 | PAC-Organization-ID | String | The client's data account ID to pull events from. |
Path Parameters
| RCOM | Key | Type | Description |
|---|---|---|---|
| R | seasonCode | String | Season code for the requested manifest. |
| R | facilityCode | String | Facility code for the requested manifest. |
| R | configurationCode | String | Configuration code for the requested manifest. |
Query Parameters
| RCOM | Key | Type | Description |
|---|---|---|---|
| R | policyCode | String | Policy (control) code governing the policy for the requestor. (Investigating if we can handle this internally) |
| O | event | String | Event (item code) for an event-specific copy of the requested manifest. |
Response
HEADERS
| Property | Type | Description |
|---|---|---|
| Request-ID | String | The same ID provided in the header of the request call returned back. |
| Content-Type | String | Supported type is application/json. |
Response Object
| Property | Type | Description |
|---|---|---|
| season | Object | Season |
| → season.code | String | Season code |
| → season.name | String | Season name |
| facility | Object | Facility |
| → facility.code | String | Facility code |
| → facility.name | String | Facility name |
| configuration | String | Configuration |
| → configuration.code | String | Configuration code |
| → configuration.name | String | Configuration name |
| capacity | Number | Configuration capacity |
| priceLevels | Collection | Collection of price levels |
| → priceLevel | Number | Price level |
| → priceLevelName | String | Price level name |
| → seatingType | String | Seating type: RESERVED, GENERAL_ADMISSION, or SECTION_GENERAL_ADMISSION |
| → capacity | Number | Price level capacity |
| → areas | Collection | Collection of areas |
| → → area.code | String | Area code |
| → → area.name | String | Area name |
| → → area.capacity | Number | Area capacity |
| → &arr; area.seatValue | Number | [Deprecated] Area seat value. This is no longer used, and can be ignored. |
| → sections | Collection | Collection of sections |
| → → section | String | Seating section (level:section) |
| → → sectionName | String | Section name |
| → → rows | Collection | Collection of rows |
| → → → row | String | Seating row |
| → → → rating | Number | [Deprecated] Row rating. This is no longer used, and can be ignored. |
| → → → fillDirection | String | Fill direction: LEFT, CENTER or RIGHT |
| → → → seats | Collection | Collection of seats |
| → → → → index | Number | Seat index. This is the count/position of the seat in the row starting at 1. |
| → → → → label | String | Seat label |
| → → → → isAisle | Boolean | Aisle indicator |
| → → → → gate | String | Gate label |
| → → → → isAccessible | Boolean | Accessible indicator |
Response Structure Diagram
Error Response Object
| Property | Type | Description |
|---|---|---|
| error | Object | Error details |
| → type | String | Error type that has occurred |
| → appErrorCode | String | Internal error code used for support. Depending on type returned, this code may be needed to handle error response differently |
| → developerMessage | String | Generic description of error that occured |
Error Types
| Error Type | Error Desc | App Error Code | HTTP Status Code | HTTP Status Desc | Retry Possible | Retry Count | Ultimate action | MS Error Level |
|---|---|---|---|---|---|---|---|---|
| AUTHORIZATION_FAILURE | Missing required headers (PAC-Channel-Code, PAC-Application-ID, or PAC-Organization-ID) | MS-401 | 401 | Unauthorized | No | 0 | Caller to analyze | ERROR |
| INVALID_API_KEY | Missing or invalid PAC-API-Key key provided | MS-401 | 401 | Unauthorized | No | 0 | Caller to analyze | ERROR |
| INVALID_REQUEST_ID | Missing Request-ID | MS-400 | 400 | Bad Request | No | 0 | Caller to analyze | ERROR |
| BAD_REQUEST | A seasonCode, facilityCode, or startDate query that is undefined (e.g. seasonCode=) | MS-400 | 400 | Bad Request | No | 0 | Caller to analyze | ERROR |
| UNAUTHORIZED_REQUEST | A valid PAC-Organization-ID or seasonCode provided does not have the correct access controls set up. | MS-403 | 403 | Forbidden | No | 0 | Caller to analyze | ERROR |
| UNHANDLED_EXCEPTION | Internal server error occurred due to backend error | MS-500 | 500 | Internal Server Error | Yes | 3 | Caller to inform Provider | FATAL |
Examples
Request
curl 'https://link-sandbox.paciolan.info/v1/manifest/AUTO2/AUTO_FAC/A4?policyCode=EXPERIENCE' ' \
-H 'User-Agent: MyApplication/1.0' \
-H 'Authorization: Bearer <BearerToken>'
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'PAC-Application-ID: com.mycompany.myapp' \
-H 'PAC-API-Key: <ApiKey>' \
-H 'PAC-Channel-Code: my-application' \
-H 'Request-ID: <RequestID>' \
-H 'PAC-Organization-ID: 999'
Responses
Success Response
{
"season": {
"code": "AUTO2",
"name": "Auto Testing"
},
"facility": {
"code": "AUTO_FAC",
"name": "Facility for Automation"
},
"configuration": {
"code": "A4",
"name": "Auto Conf 4"
},
"priceLevels": [
{
"priceLevel": 1,
"priceLevelName": "4",
"seatingType": "SECTION_GENERAL_ADMISSION",
"areas": [
{
"code": "VIP",
"name": "VIP ZONE",
"seatValue": 1.00,
"sections": [
{
"section": "A:A",
"sectionName": "Section 1",
"rows": [
{
"row": "1",
"rating": 0,
"fillDirection": "LEFT",
"seats": [
{
"index": 1,
"label": "1",
"isAisle": false,
"isAccessible": true,
"gate": "1"
},
{
"index": 2,
"label": "2",
"isAisle": false,
"isAccessible": false,
"gate": "1"
},
{
"index": 3,
"label": "3",
"isAisle": false,
"isAccessible": false,
"gate": "1"
},
{
"index": 4,
"label": "4",
"isAisle": false,
"isAccessible": false,
"gate": "1"
},
{
"index": 5,
"label": "5",
"isAisle": false,
"isAccessible": false,
"gate": "1"
},
{
"index": 6,
"label": "6",
"isAisle": false,
"isAccessible": false,
"gate": "1"
},
{
"index": 7,
"label": "7",
"isAisle": false,
"isAccessible": false,
"gate": "1"
},
{
"index": 8,
"label": "8",
"isAisle": false,
"isAccessible": false,
"gate": "1"
},
{
"index": 9,
"label": "9",
"isAisle": false,
"isAccessible": false,
"gate": "1"
},
{
"index": 10,
"label": "10",
"isAisle": false,
"isAccessible": false,
"gate": "1"
}
]
},
{
"row": "2",
"rating": 0,
"fillDirection": "LEFT",
"seats": [
{
"index": 1,
"label": "1",
"isAisle": false,
"isAccessible": false,
"gate": "1"
},
{
"index": 2,
"label": "2",
"isAisle": false,
"isAccessible": false,
"gate": "1"
},
{
"index": 3,
"label": "3",
"isAisle": false,
"isAccessible": false,
"gate": "1"
},
{
"index": 4,
"label": "4",
"isAisle": false,
"isAccessible": false,
"gate": "1"
},
{
"index": 5,
"label": "5",
"isAisle": false,
"isAccessible": false,
"gate": "1"
},
{
"index": 6,
"label": "6",
"isAisle": false,
"isAccessible": false,
"gate": "1"
},
{
"index": 7,
"label": "7",
"isAisle": false,
"isAccessible": false,
"gate": "1"
},
{
"index": 8,
"label": "8",
"isAisle": false,
"isAccessible": false,
"gate": "1"
},
{
"index": 9,
"label": "9",
"isAisle": false,
"isAccessible": false,
"gate": "1"
},
{
"index": 10,
"label": "10",
"isAisle": false,
"isAccessible": false,
"gate": "1"
}
]
},
...
....
.....
....
...
{
"row": "100",
"rating": 0,
"fillDirection": "LEFT",
"seats": [
{
"index": 1,
"label": "1",
"isAisle": false,
"isAccessible": false,
"gate": "1"
},
{
"index": 2,
"label": "2",
"isAisle": false,
"isAccessible": false,
"gate": "1"
},
{
"index": 3,
"label": "3",
"isAisle": false,
"isAccessible": false,
"gate": "1"
},
{
"index": 4,
"label": "4",
"isAisle": false,
"isAccessible": false,
"gate": "1"
},
{
"index": 5,
"label": "5",
"isAisle": false,
"isAccessible": false,
"gate": "1"
},
{
"index": 6,
"label": "6",
"isAisle": false,
"isAccessible": false,
"gate": "1"
},
{
"index": 7,
"label": "7",
"isAisle": false,
"isAccessible": false,
"gate": "1"
},
{
"index": 8,
"label": "8",
"isAisle": false,
"isAccessible": false,
"gate": "1"
},
{
"index": 9,
"label": "9",
"isAisle": false,
"isAccessible": false,
"gate": "1"
},
{
"index": 10,
"label": "10",
"isAisle": false,
"isAccessible": false,
"gate": "1"
}
]
}
]
}
],
"capacity": 1000
}
],
"capacity": 1000
}
],
"capacity": 1000
}