Agentivity API

GetConsultantWorkUpcomingPaxDepartures

The following routes are available for this service:
All Verbs	/ConsultantWorkUpcomingPaxDepartures

**GetConsultantWorkUpcomingPaxDepartures** Parameters:
Name	Parameter	Data Type	Required	Description
TravelDateStart	query	string	Yes	Date in format YYYYMMDD
TravelDateEnd	query	string	Yes	Date in format YYYYMMDD
Account	query	string	No	Comma Delimited List of Accounts
IncludeItinerary	query	boolean	No	Include Itinerary in the response
ItineraryFormatting	query	integer	No	Indicates the required formatting: 0=None(Default); 1= Html; 2 = Chart
OwningConsultantID	query	string	Yes	Comma delimited list of owning consultants ids
RequestConsultantID	query	string	No	Request Consultant ID (sign on)

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

**PassengerDeparture** Parameters:
Name	Parameter	Data Type	Required
AgentivityRef	form	int	No
RecordLocator	form	string	No
OwningAgencyLocationID	form	string	No
OwningConsultant	form	string	No
OwningConsultantID	form	string	No
GdsCode	form	string	No
Passenger	form	string	No
Account	form	string	No
TravelDate	form	DateTime?	No
TicketedStatusCode	form	string	No
TicketedStatus	form	string	No
SupplierReference	form	string	No
SMS	form	string	No
Vouchers	form	string	No
Transfers	form	string	No
IsVip	form	bool	No
PhoneNbr	form	string	No
EmailAddress	form	string	No
DestinationCities	form	string	No
DestinationCountries	form	string	No
Connections	form	string	No
Itinerary	form	ItinerarySegmentsCollection	No
ItineraryFormatted	form	string	No

**ItinerarySegment** Parameters:
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

HTTP + XML

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

POST //ConsultantWorkUpcomingPaxDepartures HTTP/1.1 
Host: api.agentivity.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetConsultantWorkUpcomingPaxDepartures xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="schemas.agentivity.com/types">
  <Limit>String</Limit>
  <Offset>String</Offset>
  <ResponseRecords>0</ResponseRecords>
  <TotalRecords>0</TotalRecords>
  <OwningCompanyCode xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </OwningCompanyCode>
  <UserName>String</UserName>
  <Account xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Account>
  <IncludeItinerary>false</IncludeItinerary>
  <ItineraryFormatting>None</ItineraryFormatting>
  <OwningConsultantID xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </OwningConsultantID>
  <RequestConsultantID>String</RequestConsultantID>
  <TravelDateEnd>String</TravelDateEnd>
  <TravelDateStart>String</TravelDateStart>
</GetConsultantWorkUpcomingPaxDepartures>

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>
    <ConsultantUpcomingPaxDeparture>
      <AgentivityRef>0</AgentivityRef>
      <RecordLocator>String</RecordLocator>
      <OwningAgencyLocationID>String</OwningAgencyLocationID>
      <OwningConsultant>String</OwningConsultant>
      <OwningConsultantID>String</OwningConsultantID>
      <GdsCode>String</GdsCode>
      <Passenger>String</Passenger>
      <Account>String</Account>
      <TravelDate>0001-01-01T00:00:00</TravelDate>
      <TicketedStatusCode>String</TicketedStatusCode>
      <TicketedStatus>String</TicketedStatus>
      <SupplierReference>String</SupplierReference>
      <SMS>String</SMS>
      <Vouchers>String</Vouchers>
      <Transfers>String</Transfers>
      <IsVip>false</IsVip>
      <PhoneNbr>String</PhoneNbr>
      <EmailAddress>String</EmailAddress>
      <DestinationCities>String</DestinationCities>
      <DestinationCountries>String</DestinationCountries>
      <Connections>String</Connections>
      <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>
    </ConsultantUpcomingPaxDeparture>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>