Agentivity API

GetCarSegments

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

**GetCarSegments** Parameters:
Name	Parameter	Data Type	Required	Description
PickUpDateStart	query	string	No
PickUpDateEnd	query	string	No

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

**CarSegmentAndVendor** Parameters:
Name	Parameter	Data Type	Required
OwningAgencyLocation	form	string	No
PNR	form	string	No
Consultant	form	string	No
SegmentStatus	form	string	No
PickUpDate	form	string	No
DropOffDate	form	string	No
CarVendorCode	form	string	No
VendorName	form	string	No
AirportCode	form	string	No
Passenger	form	string	No
Account	form	string	No
ConfirmationNbr	form	string	No
CurrencyCode	form	string	No
RateAmount	form	string	No
CarType	form	string	No
NbrOfCars	form	string	No
BookedInName	form	string	No
ServiceInformation	form	string	No
BRInformation	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 //CarSegments 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>
    <Segment>
      <OwningAgencyLocation>String</OwningAgencyLocation>
      <PNR>String</PNR>
      <Consultant>String</Consultant>
      <SegmentStatus>String</SegmentStatus>
      <PickUpDate>String</PickUpDate>
      <DropOffDate>String</DropOffDate>
      <CarVendorCode>String</CarVendorCode>
      <VendorName>String</VendorName>
      <AirportCode>String</AirportCode>
      <Passenger>String</Passenger>
      <Account>String</Account>
      <ConfirmationNbr>String</ConfirmationNbr>
      <CurrencyCode>String</CurrencyCode>
      <RateAmount>String</RateAmount>
      <CarType>String</CarType>
      <NbrOfCars>String</NbrOfCars>
      <BookedInName>String</BookedInName>
      <ServiceInformation>String</ServiceInformation>
      <BRInformation>String</BRInformation>
    </Segment>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>