GET | /BookingsWithTAUDate |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
TauDateStart | query | string | Yes | Date in format YYYYMMDD |
TauDateEnd | query | string | Yes | Date in format YYYYMMDD |
TravelDateStart | query | string | Yes | Date in format YYYYMMDD |
PNRTicketed | query | string | No | Return only PNRs that are ticketed/all |
IncludeItinerary | query | boolean | No | Include Itinerary in the response |
ItineraryFormatting | query | integer | No | Indicates the required formatting: 0=None(Default); 1= Html; 2 = Chart |
Repeat | query | string | No | Repeat |
ItinerarySegmentsToShow | query | string | No | Itinerary segments to show |
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 |
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 | List<TItem> | 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 |
---|---|---|---|---|
AgentivityRef | form | int | No | |
RecordLocator | form | string | No | |
PNRCreationDate | form | string | No | |
TravelDate | form | string | No | |
PNRTicketed | form | string | No | |
PNRCancelled | form | string | No | |
Account | form | string | No | |
OwningConsultantID | form | string | No | |
OwningConsultant | form | string | No | |
LastActionConsultantID | form | string | No | |
TAUDate | form | string | No | |
Itinerary | form | ItinerarySegmentsCollection | No | |
ItineraryFormatted | form | string | 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 |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET //BookingsWithTAUDate HTTP/1.1 Host: api.agentivity.com Accept: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <AgentivityResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="schemas.agentivity.com/types"> <ResponseMetadata> <Success>false</Success> <HasCache>false</HasCache> <HasPaging>false</HasPaging> <CacheMetadata> <IsFromCache>false</IsFromCache> <CachedAt>0001-01-01T00:00:00</CachedAt> <CacheExpiresAt>0001-01-01T00:00:00</CacheExpiresAt> </CacheMetadata> <PagingMetadata> <Limit>String</Limit> <Offset>String</Offset> <ResponseRecords>0</ResponseRecords> <TotalRecords>0</TotalRecords> </PagingMetadata> </ResponseMetadata> <ResponseReport> <Booking> <AgentivityRef>0</AgentivityRef> <RecordLocator>String</RecordLocator> <PNRCreationDate>String</PNRCreationDate> <TravelDate>String</TravelDate> <PNRTicketed>String</PNRTicketed> <PNRCancelled>String</PNRCancelled> <TAUDate>String</TAUDate> <Account>String</Account> <OwningConsultantID>String</OwningConsultantID> <OwningConsultant>String</OwningConsultant> <LastActionConsultantID>String</LastActionConsultantID> <Itinerary> <ItinerarySegment> <ArrivalTimeFormatted>String</ArrivalTimeFormatted> <BoardPoint>String</BoardPoint> <ChangeOfDayFormatted>String</ChangeOfDayFormatted> <DepartureTimeFormatted>String</DepartureTimeFormatted> <EndDate>String</EndDate> <Equipment>String</Equipment> <EquipmentCode>String</EquipmentCode> <OffPoint>String</OffPoint> <OperatorCode>String</OperatorCode> <OperatorService>String</OperatorService> <SegmentNbr>0</SegmentNbr> <SegmentStatus>String</SegmentStatus> <SegmentType>String</SegmentType> <ServiceCode>String</ServiceCode> <StartDate>String</StartDate> <TicketNumber>String</TicketNumber> <VendorLocators>String</VendorLocators> </ItinerarySegment> </Itinerary> <ItineraryFormatted>String</ItineraryFormatted> </Booking> </ResponseReport> <ResponseError> <ErrorCode>String</ErrorCode> <Message>String</Message> <StatusCode>String</StatusCode> <VerboseMessage>String</VerboseMessage> </ResponseError> </AgentivityResponse>