Agentivity API

<back to all web services

CarSegmentsByDate

The following routes are available for this service:
GET/CarSegmentsByDate
CarSegmentsByDate Parameters:
NameParameterData TypeRequiredDescription
SegmentTypequerystringNoType of segment
DateStartquerystringYesDate in format YYYYMMDD
DateEndquerystringYesDate in format YYYYMMDD
DateSearchTypequerystringNoDate search type option, a single character (T to search by segment start dates, C to search by booking creation dates).
CompanyLevelRequestBase Parameters:
NameParameterData TypeRequiredDescription
OwningCompanyCodequerystringNoComma Delimited List of Owning Company Codes
UserNamequerystringNoUserName in form of an email address
PagingMetadata Parameters:
NameParameterData TypeRequiredDescription
OffsetquerystringNoStarting Record
LimitquerystringNoNumber of records to return (PageSize)
TotalRecordsquerystringNoTotal Number of Records in a Full Reponse (if no paging)
ResponseRecordsquerystringNoTotal Number of Records in this Reponse (on this page)
CarSegmentType Enum:
Active
Passive
All
ItemResponse<TItem, TReport> Parameters:
NameParameterData TypeRequiredDescription
ResponseMetadataformResponseMetadataNo
ResponseReportformTReportNo
ResponseErrorformAgentivityErrorNo
ResponseMetadata Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo
HasCacheformboolNo
HasPagingformboolNo
CacheMetadataformCacheMetadataNo
PagingMetadataformPagingMetadataNo
CacheMetadata Parameters:
NameParameterData TypeRequiredDescription
CachedAtformDateTimeNo
CacheExpiresAtformDateTimeNo
IsFromCacheformboolNo
AgentivityError Parameters:
NameParameterData TypeRequiredDescription
ErrorCodeformstringNo
MessageformstringNo
StatusCodeformstringNo
VerboseMessageformstringNo
CarSegmentByDate Parameters:
NameParameterData TypeRequiredDescription
AgentivityRefformstringNo
RecordLocatorformstringNo
OwningAgencyLocationIDformstringNo
OwningConsultantformstringNo
AccountformstringNo
PassengersformstringNo
PickUpDateformDateTime?No
DropOffDateformDateTime?No
CarVendorCodeformstringNo
VendorNameformstringNo
SegmentStatusformstringNo
AirportCodeformstringNo
ConfirmationNbrformstringNo
CurrencyCodeformstringNo
RateAmountformstringNo
NbrOfCarsformstringNo
CarTypeformstringNo
ServiceInformationformstringNo
BRInformationformstringNo
CarSegmentTypeformstringNo
CreatingAgencyIataformstringNo
CityCodeformstringNo
TextformstringNo
VouchersformstringNo
CarRateCodeformstringNo
Report<TItemResponse, TItem> Parameters:
NameParameterData TypeRequiredDescription
ItemformTItemNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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

GET /CarSegmentsByDate HTTP/1.1 
Host: api.agentivity.com 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ResponseMetadata":{"Success":false,"HasCache":false,"HasPaging":false,"CacheMetadata":{"IsFromCache":false,"CachedAt":"\/Date(-62135596800000-0000)\/","CacheExpiresAt":"\/Date(-62135596800000-0000)\/"},"PagingMetadata":{"Offset":"String","Limit":"String","TotalRecords":0,"ResponseRecords":0}},"ResponseReport":{"Item":{"AgentivityRef":"String","RecordLocator":"String","OwningAgencyLocationID":"String","OwningConsultant":"String","Account":"String","Passengers":"String","PickUpDate":"\/Date(-62135596800000-0000)\/","DropOffDate":"\/Date(-62135596800000-0000)\/","CarVendorCode":"String","VendorName":"String","SegmentStatus":"String","AirportCode":"String","ConfirmationNbr":"String","CurrencyCode":"String","RateAmount":"String","NbrOfCars":"String","CarType":"String","ServiceInformation":"String","BRInformation":"String","CarSegmentType":"String","CreatingAgencyIata":"String","CityCode":"String","Text":"String","Vouchers":"String","CarRateCode":"String"}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}