Agentivity API

<back to all web services

SegmentsQC

The following routes are available for this service:
GET/SegmentsQC
SegmentsQC Parameters:
NameParameterData TypeRequiredDescription
AccountquerystringNoComma Delimited List of Accounts
DepartureDateStartquerystringYesDate in format YYYYMMDD
DepartureDateEndquerystringNoDate in format YYYYMMDD
VipOnlyquerybooleanNoReturn only segments that are flagged as VIP only
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
SegmentQC Parameters:
NameParameterData TypeRequiredDescription
AgentivityRefformintNo
RecordLocatorformstringNo
OwningConsultantformstringNo
PassengerformstringNo
AccountformstringNo
BoardPointformstringNo
OffPointformstringNo
DepartureTimeformstringNo
BookingClassformstringNo
SegmentStatusformstringNo
CarrierCodeformstringNo
FlightNbrformstringNo
FlightNumberFromattedformstringNo
SeatCheckformQcCheckNo
SeatFormattedformstringNo
MealCheckformQcCheckNo
MealFormattedformstringNo
ChauffeurDescformstringNo
TransferDescformstringNo
CarsFormattedformstringNo
HoteCheckformQcCheckNo
HotelsformstringNo
ShuttleDescformstringNo
TourDescformstringNo
FrequentFlyerNumbersformstringNo
PnrTicketedformstringNo
TicketNumberformstringNo
CommentsformstringNo
OpsCommentsformstringNo
IsVipformboolNo
CorporateFFsformstringNo
VendorLocatorformstringNo
Report<TItemResponse, TItem> Parameters:
NameParameterData TypeRequiredDescription
ItemformTItemNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET //SegmentsQC HTTP/1.1 
Host: api.agentivity.com 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
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,"RecordLocator":"String","OwningConsultant":"String","Passenger":"String","Account":"String","BoardPoint":"String","OffPoint":"String","DepartureTime":"String","BookingClass":"String","SegmentStatus":"String","CarrierCode":"String","FlightNbr":"String","FlightNumberFromatted":"String","SeatCheck":"Missing","SeatFormatted":"String","MealCheck":"Missing","MealFormatted":"String","ChauffeurDesc":"String","TransferDesc":"String","CarsFormatted":"String","HoteCheck":"Missing","Hotels":"String","ShuttleDesc":"String","TourDesc":"String","FrequentFlyerNumbers":"String","PnrTicketed":"String","TicketNumber":"String","Comments":"String","OpsComments":"String","IsVip":false,"CorporateFFs":"String","VendorLocator":"String"}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}