Agentivity API

<back to all web services

TicketSegmentsWithTaxByIssueDate

The following routes are available for this service:
GET/TicketSegmentsWithTax
TicketSegmentsWithTaxByIssueDate Parameters:
NameParameterData TypeRequiredDescription
UserNamequerystringYesUserName in form of an email address
AccountquerystringNoComma Delimited List of Accounts
TicketIssueDateStartquerystringYesDate in format YYYYMMDD
TicketIssueDateEndquerystringYesDate in format YYYYMMDD
PagingMetadata Parameters:
NameParameterData TypeRequiredDescription
OffsetquerystringNoStarting Record
LimitquerystringNoNumber of records to return (PageSize)
TotalRecordsquerystringNoTotal Number of Records in a Full Reponse (if no paging)
ResponseRecordsquerystringNoTotal Number of Records in this Reponse (on this page)
CollectionResponse<TItem> Parameters:
NameParameterData TypeRequiredDescription
ResponseMetadataformResponseMetadataNo
ResponseReportformList<ApiRequestPerHour>No
ResponseErrorformAgentivityErrorNo
ResponseMetadata Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo
HasCacheformboolNo
HasPagingformboolNo
CacheMetadataformCacheMetadataNo
PagingMetadataformPagingMetadataNo
CacheMetadata Parameters:
NameParameterData TypeRequiredDescription
CachedAtformDateTimeNo
CacheExpiresAtformDateTimeNo
IsFromCacheformboolNo
ApiRequestPerHour Parameters:
NameParameterData TypeRequiredDescription
RequestDateformDateTimeNo
Hour0formintNo
Hour1formintNo
Hour2formintNo
Hour3formintNo
Hour4formintNo
Hour5formintNo
Hour6formintNo
Hour7formintNo
Hour8formintNo
Hour9formintNo
Hour10formintNo
Hour11formintNo
Hour12formintNo
Hour13formintNo
Hour14formintNo
Hour15formintNo
Hour16formintNo
Hour17formintNo
Hour18formintNo
Hour19formintNo
Hour20formintNo
Hour21formintNo
Hour22formintNo
Hour23formintNo
AgentivityError Parameters:
NameParameterData TypeRequiredDescription
ErrorCodeformstringNo
MessageformstringNo
StatusCodeformstringNo
VerboseMessageformstringNo
TicketSegmentsWithTax Parameters:
NameParameterData TypeRequiredDescription
RecordlocatorformstringNo
PNRCreationDateformstringNo
TicketNumberformstringNo
AccountformstringNo
PrimaryPassengerformstringNo
VndIssueDateformstringNo
TravelAgentIDformstringNo
FOPFareformstringNo
FOPformstringNo
TotalTaxformstringNo
Tax1CodeformstringNo
Tax1AmtformstringNo
Tax2CodeformstringNo
Tax2AmtformstringNo
Tax3CodeformstringNo
Tax3AmtformstringNo
Tax4CodeformstringNo
Tax4AmtformstringNo
Tax5CodeformstringNo
Tax5AmtformstringNo
ExchangedForTicketformstringNo
CouponSequenceNbrformstringNo
CarrierformstringNo
BoardPointformstringNo
OffPointformstringNo
FlightDateformstringNo
FlightServiceClassformstringNo
FareBasisformstringNo
FlightCouponStatusformstringNo
DateLastCheckedformstringNo
OwningAgencyLocationIDformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

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

GET /TicketSegmentsWithTax 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>
    <Ticket>
      <Recordlocator>String</Recordlocator>
      <PNRCreationDate>String</PNRCreationDate>
      <TicketNumber>String</TicketNumber>
      <Account>String</Account>
      <PrimaryPassenger>String</PrimaryPassenger>
      <VndIssueDate>String</VndIssueDate>
      <TravelAgentID>String</TravelAgentID>
      <FOPFare>String</FOPFare>
      <FOP>String</FOP>
      <TotalTax>String</TotalTax>
      <Tax1Code>String</Tax1Code>
      <Tax1Amt>String</Tax1Amt>
      <Tax2Code>String</Tax2Code>
      <Tax2Amt>String</Tax2Amt>
      <Tax3Code>String</Tax3Code>
      <Tax3Amt>String</Tax3Amt>
      <Tax4Code>String</Tax4Code>
      <Tax4Amt>String</Tax4Amt>
      <Tax5Code>String</Tax5Code>
      <Tax5Amt>String</Tax5Amt>
      <ExchangedForTicket>String</ExchangedForTicket>
      <CouponSequenceNbr>String</CouponSequenceNbr>
      <Carrier>String</Carrier>
      <BoardPoint>String</BoardPoint>
      <OffPoint>String</OffPoint>
      <FlightDate>String</FlightDate>
      <FlightServiceClass>String</FlightServiceClass>
      <FareBasis>String</FareBasis>
      <FlightCouponStatus>String</FlightCouponStatus>
      <DateLastChecked>String</DateLastChecked>
      <OwningAgencyLocationID>String</OwningAgencyLocationID>
    </Ticket>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>