Agentivity API

AirSegmentsWithVendorLocatorsByUser

The following routes are available for this service:
GET	/AirSegmentsWithVendorLocators

**AirSegmentsWithVendorLocatorsByUser** Parameters:
Name	Parameter	Data Type	Required	Description
Account	query	string	No	Comma Delimited List of Accounts
DepartureDateStart	query	string	Yes	Date in format YYYYMMDD
DepartureDateEnd	query	string	No	Date in format YYYYMMDD
IsVip	query	boolean	No	Return only PNRs that are or are not flagged as VIP bookings

**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<ApiRequestPerHour>	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

**ApiRequestPerHour** Parameters:
Name	Parameter	Data Type	Required
RequestDate	form	DateTime	No
Hour0	form	int	No
Hour1	form	int	No
Hour2	form	int	No
Hour3	form	int	No
Hour4	form	int	No
Hour5	form	int	No
Hour6	form	int	No
Hour7	form	int	No
Hour8	form	int	No
Hour9	form	int	No
Hour10	form	int	No
Hour11	form	int	No
Hour12	form	int	No
Hour13	form	int	No
Hour14	form	int	No
Hour15	form	int	No
Hour16	form	int	No
Hour17	form	int	No
Hour18	form	int	No
Hour19	form	int	No
Hour20	form	int	No
Hour21	form	int	No
Hour22	form	int	No
Hour23	form	int	No

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

**AirSegmentWithVendorLocators** Parameters:
Name	Parameter	Data Type	Required
RecordLocator	form	string	No
PNRCreationDate	form	DateTime?	No
AgentivityRef	form	int	No
Account	form	string	No
OwningConsultantID	form	string	No
OwningConsultant	form	string	No
OwningAgencyLocationID	form	string	No
PaxList	form	string	No
AirSegmentNbr	form	int	No
SegmentStatus	form	string	No
BoardPoint	form	string	No
OffPoint	form	string	No
DepartureDate	form	string	No
DepartureTime	form	string	No
ArrivalTime	form	string	No
ChangeOfDay	form	string	No
CarrierCode	form	string	No
FlightNbr	form	string	No
BookingCode	form	string	No
PNRTicketed	form	string	No
VendorLocator	form	string	No
CheckInURL	form	string	No
IsVip	form	bool	No
PhoneNbr	form	string	No
EmailAddress	form	string	No
TicketNumber	form	string	No
TicketCouponStatus	form	string	No
TicketCouponDateLastChecked	form	DateTime?	No
OperatingCarrierName	form	string	No

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 /AirSegmentsWithVendorLocators 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>
    <AirSegment>
      <RecordLocator>String</RecordLocator>
      <PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
      <AgentivityRef>0</AgentivityRef>
      <Account>String</Account>
      <OwningConsultantID>String</OwningConsultantID>
      <OwningConsultant>String</OwningConsultant>
      <OwningAgencyLocationID>String</OwningAgencyLocationID>
      <PaxList>String</PaxList>
      <AirSegmentNbr>0</AirSegmentNbr>
      <SegmentStatus>String</SegmentStatus>
      <BoardPoint>String</BoardPoint>
      <OffPoint>String</OffPoint>
      <DepartureDate>String</DepartureDate>
      <DepartureTime>String</DepartureTime>
      <ArrivalTime>String</ArrivalTime>
      <ChangeOfDay>String</ChangeOfDay>
      <CarrierCode>String</CarrierCode>
      <FlightNbr>String</FlightNbr>
      <BookingCode>String</BookingCode>
      <PNRTicketed>String</PNRTicketed>
      <VendorLocator>String</VendorLocator>
      <CheckInURL>String</CheckInURL>
      <IsVip>false</IsVip>
      <PhoneNbr>String</PhoneNbr>
      <EmailAddress>String</EmailAddress>
      <TicketNumber>String</TicketNumber>
      <TicketCouponStatus>String</TicketCouponStatus>
      <TicketCouponDateLastChecked>0001-01-01T00:00:00</TicketCouponDateLastChecked>
      <OperatingCarrierName>String</OperatingCarrierName>
    </AirSegment>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>