| GET | /EventBookings |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UserName | query | string | Yes | UserName in form of an email address |
| EventCode | query | string | No | Event code |
| SplitMultiplePassengers | query | boolean | No | Split multiple passengers |
| IncludeNotes | query | boolean | No | Include notes in the response |
| IncludeArrivalDepartures | query | boolean | No | Include arrival departures |
| FormattingStyle | query | integer | No | Indicate the required formatting: 0=None(Default), 1=Html, 2=Chart |
| ItinerarySegmentsToShow | query | string | No | Itinerary segments to show |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Offset | query | string | No | Starting Record |
| Limit | query | string | No | Number of records to return (PageSize) |
| TotalRecords | query | string | No | Total Number of Records in a Full Reponse (if no paging) |
| ResponseRecords | query | string | No | Total Number of Records in this Reponse (on this page) |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseMetadata | form | ResponseMetadata | No | |
| ResponseReport | form | TReport | No | |
| ResponseError | form | AgentivityError | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Success | form | bool | No | |
| HasCache | form | bool | No | |
| HasPaging | form | bool | No | |
| CacheMetadata | form | CacheMetadata | No | |
| PagingMetadata | form | PagingMetadata | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CachedAt | form | DateTime | No | |
| CacheExpiresAt | form | DateTime | No | |
| IsFromCache | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ErrorCode | form | string | No | |
| Message | form | string | No | |
| StatusCode | form | string | No | |
| VerboseMessage | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RecordLocator | form | string | No | |
| PNRCreationDate | form | DateTime | No | |
| PaxList | form | string | No | |
| PaxCount | form | int | No | |
| InboundAirline | form | string | No | |
| InboundFlightNumber | form | string | No | |
| InboundArrivalCity | form | string | No | |
| InboundArrivalDate | form | DateTime? | No | |
| InboundArrivalTime | form | string | No | |
| OutboundAirline | form | string | No | |
| OutboundFlightNumber | form | string | No | |
| OutboundDepartureCity | form | string | No | |
| OutboundDepartureDate | form | DateTime? | No | |
| OutboundDepartureTime | form | string | No | |
| Notes | form | string | No | |
| Emails | form | string | No | |
| Mobile | form | string | No | |
| TotalTicketedValue | form | string | No | |
| AgentivityRef | form | int | No | |
| ItineraryFormatted | form | string | No | |
| Itinerary | form | ItinerarySegmentsCollection | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SegmentType | form | string | No | |
| SegmentNbr | form | int | No | |
| BoardPoint | form | string | No | |
| OffPoint | form | string | No | |
| OperatorCode | form | string | No | |
| OperatorService | form | string | No | |
| SegmentStatus | form | string | No | |
| DepartureTimeFormatted | form | string | No | |
| ArrivalTimeFormatted | form | string | No | |
| ChangeOfDayFormatted | form | string | No | |
| ServiceCode | form | string | No | |
| StartDate | form | string | No | |
| EndDate | form | string | No | |
| TicketNumber | form | string | No | |
| VendorLocators | query | string | No | Comma separated list of vendor locators |
| EquipmentCode | form | string | No | |
| Equipment | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Item | form | TItem | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET //EventBookings HTTP/1.1 Host: api.agentivity.com Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"ResponseMetadata":{"Success":false,"HasCache":false,"HasPaging":false,"CacheMetadata":{"IsFromCache":false,"CachedAt":"\/Date(-62135596800000-0000)\/","CacheExpiresAt":"\/Date(-62135596800000-0000)\/"},"PagingMetadata":{"Offset":"String","Limit":"String","TotalRecords":0,"ResponseRecords":0}},"ResponseReport":{"Item":{"RecordLocator":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","PaxList":"String","PaxCount":0,"AgentivityRef":0,"ItineraryFormatted":"String","Itinerary":[{"SegmentType":"String","SegmentNbr":0,"BoardPoint":"String","OffPoint":"String","OperatorCode":"String","OperatorService":"String","SegmentStatus":"String","DepartureTimeFormatted":"String","ArrivalTimeFormatted":"String","ChangeOfDayFormatted":"String","ServiceCode":"String","StartDate":"String","EndDate":"String","TicketNumber":"String","VendorLocators":"String","EquipmentCode":"String","Equipment":"String"}],"InboundAirline":"String","InboundFlightNumber":"String","InboundArrivalCity":"String","InboundArrivalDate":"\/Date(-62135596800000-0000)\/","InboundArrivalTime":"String","OutboundAirline":"String","OutboundFlightNumber":"String","OutboundDepartureCity":"String","OutboundDepartureDate":"\/Date(-62135596800000-0000)\/","OutboundDepartureTime":"String","Notes":"String","Emails":"String","Mobile":"String","TotalTicketedValue":"String"}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}