Agentivity API

AirSegmentsByDate

The following routes are available for this service:
GET	/AirSegmentsByDate/user		Depreciated, please use AirSegmentsByDate
GET	/AirSegmentsByDate

**AirSegmentsByDate** Parameters:
Name	Parameter	Data Type	Required	Description
DateStart	query	string	Yes	Date in format YYYYMMDD
DateEnd	query	string	Yes	Date in format YYYYMMDD
DateSearchType	query	string	No	Date search type option, a single character (T to search by segment start dates, C to search by booking creation dates).

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

**ItemResponse<TItem, TReport>** Parameters:
Name	Parameter	Data Type	Required
ResponseMetadata	form	ResponseMetadata	No
ResponseReport	form	TReport	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

**AirSegmentByDate** Parameters:
Name	Parameter	Data Type	Required
AgentivityRef	form	string	No
RecordLocator	form	string	No
OwningAgencyLocationID	form	string	No
OwningConsultant	form	string	No
Account	form	string	No
Passengers	form	string	No
DepartureDate	form	DateTime?	No
DepartureTime	form	string	No
ArrivalDate	form	DateTime?	No
ArrivalTime	form	string	No
CarrierCode	form	string	No
BoardPoint	form	string	No
OffPoint	form	string	No
FlightNbr	form	string	No
BookingCode	form	string	No
CreatingAgencyIata	form	string	No
SegmentStatus	form	string	No

**Report<TItemResponse, TItem>** Parameters:
Name	Parameter	Data Type	Required	Description
Item	form	TItem	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 //AirSegmentsByDate/user 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>
    <Item>
      <AgentivityRef>String</AgentivityRef>
      <RecordLocator>String</RecordLocator>
      <OwningAgencyLocationID>String</OwningAgencyLocationID>
      <OwningConsultant>String</OwningConsultant>
      <Account>String</Account>
      <Passengers>String</Passengers>
      <DepartureDate>0001-01-01T00:00:00</DepartureDate>
      <DepartureTime>String</DepartureTime>
      <ArrivalDate>0001-01-01T00:00:00</ArrivalDate>
      <ArrivalTime>String</ArrivalTime>
      <CarrierCode>String</CarrierCode>
      <BoardPoint>String</BoardPoint>
      <OffPoint>String</OffPoint>
      <FlightNbr>String</FlightNbr>
      <BookingCode>String</BookingCode>
      <CreatingAgencyIata>String</CreatingAgencyIata>
      <SegmentStatus>String</SegmentStatus>
    </Item>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>