Agentivity API

<back to all web services

PassiveSegmentsByUser

The following routes are available for this service:
GET/PassiveSegments
PassiveSegmentsByUser Parameters:
NameParameterData TypeRequiredDescription
ArrivalDateEndquerystringYesDate in format YYYYMMDD
ArrivalDateStartquerystringYesDate in format YYYYMMDD
SegmentTypequerystringNoType of segment
AccountquerystringNoAccount
CityCodequerystringNo3 letter city code
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)
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
PassiveSegmentWithOwningInformation Parameters:
NameParameterData TypeRequiredDescription
AgentivityRefformintNo
OwningAgencyLocationIDformstringNo
RecordLocatorformstringNo
OwningConsultantIDformstringNo
OwningConsultantformstringNo
AccountformstringNo
SegmentStatusformstringNo
StartDateformstringNo
DepartureDateformstringNo
NbrNightsformstringNo
VendorCodeformstringNo
CityCodeformstringNo
SegmentTypeformstringNo
TextformstringNo
PassengerformstringNo
AddressformstringNo
BookingReasonCodeformstringNo
BookingSourceformstringNo
CommissionInformationformstringNo
ConfirmationNumberformstringNo
RateCodeformstringNo
RateQuotedformstringNo
RateAccessCodeformstringNo
PropertyNameformstringNo
PropertyNumberformstringNo
ServiceInformationformstringNo
TotalAirSegsformstringNo
HotelCommissionformstringNo
CountryNameformstringNo
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 /PassiveSegments HTTP/1.1 
Host: servicestack.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":0,"OwningConsultantID":"String","StartDate":"String","NbrNights":"String","VendorCode":"String","CityCode":"String","SegmentType":"String","Text":"String","Address":"String","BookingReasonCode":"String","BookingSource":"String","CommissionInformation":"String","ConfirmationNumber":"String","RateCode":"String","RateQuoted":"String","RateAccessCode":"String","PropertyName":"String","PropertyNumber":"String","ServiceInformation":"String","TotalAirSegs":"String","HotelCommission":"String","CountryName":"String","RecordLocator":"String","OwningAgencyLocationID":"String","OwningConsultant":"String","Account":"String","Passenger":"String","DepartureDate":"String","SegmentStatus":"String"}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}