Agentivity API

PassiveSegmentsByUser

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

**PassiveSegmentsByUser** Parameters:
Name	Parameter	Data Type	Required	Description
ArrivalDateEnd	query	string	Yes	Date in format YYYYMMDD
ArrivalDateStart	query	string	Yes	Date in format YYYYMMDD
SegmentType	query	string	No	Type of segment
Account	query	string	No	Account
CityCode	query	string	No	3 letter city code
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

**PassiveSegmentWithOwningInformation** Parameters:
Name	Parameter	Data Type	Required
AgentivityRef	form	int	No
OwningAgencyLocationID	form	string	No
RecordLocator	form	string	No
OwningConsultantID	form	string	No
OwningConsultant	form	string	No
Account	form	string	No
SegmentStatus	form	string	No
StartDate	form	string	No
DepartureDate	form	string	No
NbrNights	form	string	No
VendorCode	form	string	No
CityCode	form	string	No
SegmentType	form	string	No
Text	form	string	No
Passenger	form	string	No
Address	form	string	No
BookingReasonCode	form	string	No
BookingSource	form	string	No
CommissionInformation	form	string	No
ConfirmationNumber	form	string	No
RateCode	form	string	No
RateQuoted	form	string	No
RateAccessCode	form	string	No
PropertyName	form	string	No
PropertyNumber	form	string	No
ServiceInformation	form	string	No
TotalAirSegs	form	string	No
HotelCommission	form	string	No
CountryName	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 //PassiveSegments 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>
      <Address>String</Address>
      <AgentivityRef>0</AgentivityRef>
      <BookingReasonCode>String</BookingReasonCode>
      <BookingSource>String</BookingSource>
      <CityCode>String</CityCode>
      <CommissionInformation>String</CommissionInformation>
      <ConfirmationNumber>String</ConfirmationNumber>
      <CountryName>String</CountryName>
      <HotelCommission>String</HotelCommission>
      <NbrNights>String</NbrNights>
      <OwningConsultantID>String</OwningConsultantID>
      <PropertyName>String</PropertyName>
      <PropertyNumber>String</PropertyNumber>
      <RateAccessCode>String</RateAccessCode>
      <RateCode>String</RateCode>
      <RateQuoted>String</RateQuoted>
      <SegmentType>String</SegmentType>
      <ServiceInformation>String</ServiceInformation>
      <StartDate>String</StartDate>
      <Text>String</Text>
      <TotalAirSegs>String</TotalAirSegs>
      <VendorCode>String</VendorCode>
      <RecordLocator>String</RecordLocator>
      <OwningAgencyLocationID>String</OwningAgencyLocationID>
      <OwningConsultant>String</OwningConsultant>
      <Account>String</Account>
      <Passenger>String</Passenger>
      <DepartureDate>String</DepartureDate>
      <SegmentStatus>String</SegmentStatus>
    </Item>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>