Agentivity API

<back to all web services

GetTicketsIssued

The following routes are available for this service:
GET/TicketsIssued
GetTicketsIssued Parameters:
NameParameterData TypeRequiredDescription
DateStartquerystringYesDate in format YYYYMMDD
DateEndquerystringYesDate in format YYYYMMDD
IATAquerystringNoIATA code
OwningAgencyLocationIDquerystringNoComma Delimited List of PCCs
CompanyLevelRequestBase Parameters:
NameParameterData TypeRequiredDescription
OwningCompanyCodequerystringNoComma Delimited List of Owning Company Codes
UserNamequerystringNoUserName in form of an email address
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<TItem>No
ResponseErrorformAgentivityErrorNo
ResponseMetadata Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo
HasCacheformboolNo
HasPagingformboolNo
CacheMetadataformCacheMetadataNo
PagingMetadataformPagingMetadataNo
CacheMetadata Parameters:
NameParameterData TypeRequiredDescription
CachedAtformDateTimeNo
CacheExpiresAtformDateTimeNo
IsFromCacheformboolNo
AgentivityError Parameters:
NameParameterData TypeRequiredDescription
ErrorCodeformstringNo
MessageformstringNo
StatusCodeformstringNo
VerboseMessageformstringNo
TicketsIssued Parameters:
NameParameterData TypeRequiredDescription
RecordLocatorformstringNo
TktNumberformstringNo
FOPformstringNo
PassengerformstringNo
ConsultantformstringNo
RemarkTextformstringNo
AirlineCodeformstringNo
TravAgntIDformstringNo
PCCformstringNo
PrintedCurrencyformstringNo
FOPFareformstringNo
DateformDateTimeNo
DueDateformDateTime?No
TicketingAgentIDformstringNo
TicketingAgentformstringNo

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 //TicketsIssued 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>
    <TicketsIssued>
      <RecordLocator>String</RecordLocator>
      <TktNumber>String</TktNumber>
      <FOP>String</FOP>
      <Passenger>String</Passenger>
      <Consultant>String</Consultant>
      <RemarkText>String</RemarkText>
      <AirlineCode>String</AirlineCode>
      <TravAgntID>String</TravAgntID>
      <PCC>String</PCC>
      <PrintedCurrency>String</PrintedCurrency>
      <FOPFare>String</FOPFare>
      <Date>0001-01-01T00:00:00</Date>
      <DueDate>0001-01-01T00:00:00</DueDate>
      <TicketingAgentID>String</TicketingAgentID>
      <TicketingAgent>String</TicketingAgent>
    </TicketsIssued>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>