/listings/{listingId}
Description
The Get Listings API endpoint will return seats (as tokens) grouped by event accessId for the given listingId provided.
Flow
- A patron on MyAccount will select items/seats (from any event) that they want to list for resale.
- The Paciolan system will then generate and append a
listingId
identifier to the integrator's website when navigating the user over. - Integrator will then make an API call to this Get Listings API with the
listingId
to receive tokens for each item/seat selected by the patron.
Supported Methods
- GET
Request
/listings/{listingId}
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 | PThe 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. |
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
RCO | Property | Type | Description |
---|---|---|---|
R | listingId | String | Request listing ID |
R | tickets | Array of Objects | |
R | → accessId | String | The accessId for the event, will always be the main/home or parking event. |
R | → seats | Array of Objects | |
R | → → season | String | Season Code |
R | → → item | String | Item Code |
R | → → seatingType | String | Seating type. One of RESERVED , GENERAL_ADMISSION , or SECTION_GENERAL_ADMISSION . |
R | → → associationType | String | Association type. Incomplete list: PARKING , VIP , etc. |
R | → → seatAttributes | Array of Strings | Seating attributes. Currently only ADA and LIMITED_VIEW available. |
R | → → section | String | Section code. (LEVEL:SECTION) |
R | → → row | String | Row |
R | → → seat | String | Seat |
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 |
---|---|---|---|---|---|---|---|---|
LISTINGID_NOT_FOUND | listingId does not exit | MS-404 | 404 | Not Found | No | 0 | Caller to analyze | ERROR |
LISTING_INFO_NOT_FOUND | listingId was found with invalid data | MS-404 | 404 | Not Found | No | 0 | Caller to inform Provider | 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/listings/A3qnemZ' \
-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>'
Responses
Success Response
< HTTP/1.1 200
{
"listingId": "A3qnemZ",
"tickets": [
{
"accessId": "129:FB23:FB01",
"seats": [
{
"season": "FB23",
"item": "FB01",
"seatingType": "RESERVED",
"associationType": null,
"seatAttributes": ["ADA"],
"section": "ES:9",
"row": "30",
"seat": "24",
"token": "129BL7ASUULGLT2X8"
},
{
"season": "FB223",
"item": "FB01",
"seatingType": "SECTION_GENERAL_ADMISSION",
"associationType": null,
"seatAttributes": ["LIMITED_VIEW"],
"section": "ES:9",
"row": "30",
"seat": "25",
"token": "129BL7ASUULGLT2X0"
},
{
"season": "FB23",
"item": "FB01VIP",
"seatingType": "RESERVED",
"associationType": "VIP",
"seatAttributes": null,
"section": "ES:9",
"row": "30",
"seat": "26",
"token": "129BL7ASUULGLT2X9"
}
]
}
<HTTP/1.1 200
{
"listingId": "A3qnemZ",
"tickets": [
{
"accessId": "129:FB23:FB01",
"seats": [
{
"season": "FB23",
"item": "FB01",
"seatingType": "RESERVED",
"associationType": null,
"seatAttributes": ["ADA"],
"section": "ES:9",
"row": "30",
"seat": "24",
"token": "129BL7ASUULGLT2X8"
},
{
"season": "FB223",
"item": "FB01",
"seatingType": "SECTION_GENERAL_ADMISSION",
"associationType": null,
"seatAttributes": ["LIMITED_VIEW"],
"section": "ES:9",
"row": "30",
"seat": "25",
"token": "129BL7ASUULGLT2X0"
},
{
"season": "FB23",
"item": "FB01VIP",
"seatingType": "RESERVED",
"associationType": "VIP",
"seatAttributes": null,
"section": "ES:9",
"row": "30",
"seat": "26",
"token": "129BL7ASUULGLT2X9"
}
]
},
{
"accessId": "129:FB23:FB02",
"seats": [
{
"season": "FB23",
"item": "FB02",
"seatingType": "RESERVED",
"associationType": null,
"seatAttributes": null,
"section": "ES:11",
"row": "29",
"seat": "15",
"token": "129BL7ASUUMHMT1W7"
}
]
}
]
}
RouteId Not Found
< HTTP/1.1 404
{
"listingId": "C2qnfnY",
"error":{
"type": "LISTINGID_NOT_FOUND",
"appErrorCode": "MS-404",
"developerMessage": "Listing id C2qnfnY not found"
}
}