Agentivity API

GetHotelSegments

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

**GetHotelSegments** Parameters:
Name	Parameter	Data Type	Required	Description
DateStart	query	string	Yes	Date in format YYYYMMDD
DateEnd	query	string	Yes	Date in format YYYYMMDD
Account	query	string	No	Comma Delimited List of Accounts
CityCode	query	string	No	3 letter city code
WithNotepad	query	string	No	Include Notepad Entry: 1=Yes
OwningAgencyLocationID	query	string	No	Comma Delimited List of PCCs
OwningAgencyCountryCode	query	string	No	Comma Delimited List of CountryCodes
DateSearchType	query	string	No	Date search type option, a single character (A to search by Arrival dates, C to search by booking creation dates, S to search by segment creation dates).
IsPassive	query	string	No	IsPassive=0 (only include non-passive segments). IsPassive=1 (only include passive segments).
CustomField	query	string	No	Comma Delimited List of Custom Fields

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

**HotelSegment** Parameters:
Name	Parameter	Data Type	Required
AgentivityRef	form	int	No
PNRCreationDate	form	DateTime?	No
HotelSegmentNbr	form	string	No
RecordLocator	form	string	No
OwningAgencyLocationID	form	string	No
Account	form	string	No
OwningConsultantID	form	string	No
OwningConsultant	form	string	No
StatusCode	form	string	No
ArrivalDate	form	DateTime?	No
DepartureDate	form	DateTime?	No
NbrNights	form	int	No
VendorCode	form	string	No
PropertyName	form	string	No
PropertyNbr	form	string	No
PropertyAddress	form	string	No
PropertyPhoneNbr	form	string	No
CityCode	form	string	No
CityName	form	string	No
CountryCode	form	string	No
CountryName	form	string	No
Passenger	form	string	No
ConfirmationNbr	form	string	No
RateAccessCode	form	string	No
RoomBookingCode	form	string	No
CurrencyCode	form	string	No
RateAmount	form	string	No
NbrRooms	form	int	No
BookedInName	form	string	No
ServiceInformation	form	string	No
TotalAirSegs	form	string	No
CreatingAgencyIata	form	string	No
SegmentCreationDate	form	DateTime?	No
IsCommissionable	form	bool?	No
Commission	form	string	No
IsPassive	form	bool	No
CustomFields	form	CustomFieldsCollection	No
HotelNotepad	form	string	No

**CustomFieldData** Parameters:
Name	Parameter	Data Type	Required	Description
FieldName	form	string	No
FieldValue	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 //HotelSegments 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>0</AgentivityRef>
      <PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
      <HotelSegmentNbr>String</HotelSegmentNbr>
      <RecordLocator>String</RecordLocator>
      <OwningAgencyLocationID>String</OwningAgencyLocationID>
      <Account>String</Account>
      <OwningConsultantID>String</OwningConsultantID>
      <OwningConsultant>String</OwningConsultant>
      <StatusCode>String</StatusCode>
      <ArrivalDate>0001-01-01T00:00:00</ArrivalDate>
      <DepartureDate>0001-01-01T00:00:00</DepartureDate>
      <NbrNights>0</NbrNights>
      <VendorCode>String</VendorCode>
      <PropertyName>String</PropertyName>
      <PropertyPhoneNbr>String</PropertyPhoneNbr>
      <PropertyNbr>String</PropertyNbr>
      <PropertyAddress>String</PropertyAddress>
      <CityCode>String</CityCode>
      <CityName>String</CityName>
      <CountryCode>String</CountryCode>
      <CountryName>String</CountryName>
      <Passenger>String</Passenger>
      <ConfirmationNbr>String</ConfirmationNbr>
      <RateAccessCode>String</RateAccessCode>
      <RoomBookingCode>String</RoomBookingCode>
      <CurrencyCode>String</CurrencyCode>
      <RateAmount>String</RateAmount>
      <NbrRooms>0</NbrRooms>
      <BookedInName>String</BookedInName>
      <ServiceInformation>String</ServiceInformation>
      <TotalAirSegs>String</TotalAirSegs>
      <CreatingAgencyIata>String</CreatingAgencyIata>
      <SegmentCreationDate>0001-01-01T00:00:00</SegmentCreationDate>
      <IsCommissionable>false</IsCommissionable>
      <Commission>String</Commission>
      <IsPassive>false</IsPassive>
      <CustomFields>
        <CustomField>
          <FieldName>String</FieldName>
          <FieldValue>String</FieldValue>
        </CustomField>
      </CustomFields>
      <HotelNotepad>String</HotelNotepad>
    </Item>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>