/catalog/events

Description

The events endpoint returns a list of items available for secondary.

Supported Methods

• GET

Supported Media Types

Request

• N/A

Response

• application/json

Request

/catalog/events

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.

Query Parameters

RCOM	Key	Type	Description
O	startDate	Date	Date in the format of YYYY-MM-DD. Applicable to events only. When specified, only those event items with a start date on or after this date will be returned.
O	seasonCode	String	A (single) season code may be specified to filter output.
O	facilityCode	String	A (single) facility code may be specified to filter output.

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
seasonCode	String	Season code
itemCode	String	Item code
itemBasis	Enum (JSON String)	Item basis
itemName	String	Item name; Precedence: 1. Internet Name 2. Item Name 3. Event name
startDate	Date	Date part (before "T" delimiter) of ISO 8601 compliant date.
startTime	Time / Enum ["TBD"]	Time part (after "T" delimiter) of ISO 8601 compliant time. Can also return TBD if no start time is set.
endDate	Date	Date part (before "T" delimiter) of ISO 8601 compliant date.
endTime	Time / Enum ["TBD"]	Time part (after "T" delimiter) of ISO 8601 compliant time. Can also return TBD if no end time is set.
facilityCode	String	Facility code
facilityName	String	Facility Name
association	Object (nullable)	Association Object
-> type	String	Association type
-> associatedTo	String	Associated to accessId
accessId	String	Main event accessId
distributorCode	String (nullable)	Event distributor code

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
NOT_FOUND	An otherwise valid but undefined seasonCode or facilityCode	MS-404	404	Not Found	No	0	Caller to analyze	ERROR
INVALID_INPUT	A request made with a startDate in the past	MS-422	422	Unprocessable Content	No	0	Caller to analyze	ERROR

Response Notes

• Items for which startDate and/or endDate are not applicable shall return null.
• Items for which facilityCode & facilityName are not applicable shall return null.

Examples

Request

curl 'https://link-sandbox.paciolan.info/v1/catalog/events' \
  -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

[
  {
    "seasonCode": "F23",
    "itemCode": "F01",
    "itemBasis": "SINGLE",
    "itemName": "Football Game 1",
    "startDate": "2023-05-20",
    "startTime": "20:30:00Z",
    "endDate": null,
    "endTime": null,
    "facilityCode": "ABC",
    "configurationCode": "DC",
    "facilityName": "Pavilion",
    "association": null,
    "accessId": "999:F23:F01",
    "distributorCode": "LFTX"
  },
  {
    "seasonCode": "F23",
    "itemCode": "P01",
    "itemBasis": "SINGLE",
    "itemName": "Parking for Football Game 1",
    "startDate": "2023-05-20",
    "startTime": "20:30:00Z",
    "endDate": null,
    "endTime": null,
    "facilityCode": "ABC",
    "configurationCode": "DC",
    "facilityName": "Pavilion",
    "association": {
      "type": "PARKING",
      "associatedTo": ["999:F23:F01"]
    },
    "accessId": "999:F23:P01",
    "distributorCode": "LFTX"
  },
  {
    "seasonCode": "F23",
    "itemCode": "F02",
    "itemBasis": "SINGLE",
    "itemName": "Football Game 2",
    "startDate": "2023-08-22",
    "startTime": "19:00:00Z",
    "endDate": null,
    "endTime": null,
    "facilityCode": "ABC",
    "configurationCode": "DC",
    "facilityName": "Pavilion",
    "association": null,
    "accessId": "999:F23:F02",
    "distributorCode": "LFTX"
  },
  {
    "seasonCode": "F23",
    "itemCode": "F03",
    "itemBasis": "SINGLE",
    "itemName": "Football Game 3",
    "startDate": "2023-09-22",
    "startTime": "19:00:00Z",
    "endDate": null,
    "endTime": null,
    "facilityCode": "ABC",
    "configurationCode": "DC",
    "facilityName": "Pavilion",
    "association": null,
    "accessId": "999:F23:F03",
    "distributorCode": "LFTX"
  },
  {
    "seasonCode": "F23",
    "itemCode": "P03",
    "itemBasis": "SINGLE",
    "itemName": "Parking for Football Game 3",
    "startDate": "2023-05-20",
    "startTime": "20:30:00Z",
    "endDate": null,
    "endTime": null,
    "facilityCode": "ABC",
    "configurationCode": "DC",
    "facilityName": "Pavilion",
    "association": {
      "type": "PARKING",
      "associatedTo": ["999:F23:F03"]
    },
    "accessId": "999:F23:P03",
    "distributorCode": "LFTX"
  }
]

Invalid startDate

< HTTP/1.1 422

{
  "error":{
    "type": "INVALID_INPUT",
    "appErrorCode": "MS-422",
    "developerMessage": "The startDate provided is in the past"
  }
}