Agentivity API

GetBookingEventsDetails

The following routes are available for this service:
All Verbs	/BookingEventsDetails

**GetBookingEventsDetails** Parameters:
Name	Parameter	Data Type	Required	Description
EventDateStart	query	string	Yes	Date in format YYYYMMDD
EventDateEnd	query	string	Yes	Date in format YYYYMMDD
EventType	query	string	No	Comma Delimited List of Event Types
OwningAgencyLocationID	query	string	No	Comma Delimited List of PCCs

**CompanyLevelRequestBase** Parameters:
Name	Parameter	Data Type	Required	Description
OwningCompanyCode	query	string	No	Comma Delimited List of Owning Company Codes
UserName	query	string	No	UserName in form of an email address

**PagingMetadata** Parameters:
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)

**CollectionResponse<TItem>** Parameters:
Name	Parameter	Data Type	Required
ResponseMetadata	form	ResponseMetadata	No
ResponseReport	form	List<TItem>	No
ResponseError	form	AgentivityError	No

**ResponseMetadata** Parameters:
Name	Parameter	Data Type	Required
Success	form	bool	No
HasCache	form	bool	No
HasPaging	form	bool	No
CacheMetadata	form	CacheMetadata	No
PagingMetadata	form	PagingMetadata	No

**CacheMetadata** Parameters:
Name	Parameter	Data Type	Required
CachedAt	form	DateTime	No
CacheExpiresAt	form	DateTime	No
IsFromCache	form	bool	No

**AgentivityError** Parameters:
Name	Parameter	Data Type	Required
ErrorCode	form	string	No
Message	form	string	No
StatusCode	form	string	No
VerboseMessage	form	string	No

**BookingEventsDetail** Parameters:
Name	Parameter	Data Type	Required
RecordLocator	form	string	No
PNRCreationDate	form	DateTime?	No
Events	form	List<EventTypeItem>	No
AgentivityRef	form	int	No
Itinerary	form	List<BookingExtItinerarySegment>	No
TicketNumbers	form	string[]	No

**EventTypeItem** Parameters:
Name	Parameter	Data Type	Required	Description
EventType	form	string	No
EventDateTime	form	DateTime?	No

**BookingExtItinerarySegment** Parameters:
Name	Parameter	Data Type	Required	Description
OperatorCodeName	form	string	No
ServiceCodeName	form	string	No

**ItinerarySegment** Parameters:
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

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

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST //BookingEventsDetails HTTP/1.1 
Host: api.agentivity.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"EventDateStart":"String","EventDateEnd":"String","EventType":["String"],"OwningAgencyLocationID":["String"],"OwningCompanyCode":["String"],"UserName":"String","Offset":"String","Limit":"String","TotalRecords":0,"ResponseRecords":0}

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":[{"RecordLocator":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","Events":[{"EventType":"String","EventDateTime":"\/Date(-62135596800000-0000)\/"}],"AgentivityRef":0,"Itinerary":[{"OperatorCodeName":"String","ServiceCodeName":"String","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"}],"TicketNumbers":["String"]}],"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}