Agentivity API

<back to all web services

GetConsultantPnrActivity

The following routes are available for this service:
GET/ConsultantPnrActivity
GetConsultantPnrActivity Parameters:
NameParameterData TypeRequiredDescription
ActivityDateStartquerystringYesDate in format YYYYMMDD
ActivityDateEndquerystringNoDate in format YYYYMMDD
OwningAgencyLocationIDquerystringNoComma Delimited List of PCCs
TeamquerystringNoTeam name
QualifierquerystringNoQualifier
OnlySummaryquerybooleanNoList only summary if selected true
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)
CollectionResponse<TItem> Parameters:
NameParameterData TypeRequiredDescription
ResponseMetadataformResponseMetadataNo
ResponseReportformList<TItem>No
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
ConsultantPnrActivity Parameters:
NameParameterData TypeRequiredDescription
ConsultantformstringNo
TransactionAgentformstringNo
LocationformstringNo
TeamformstringNo
TotalBookingsformintNo
DomesticformintNo
InternationalformintNo
LandformintNo
CancelledformintNo
ComplexformintNo
ChangedOwnDomesticformintNo
ChangedOwnInternationalformintNo
ChangedOtherDomesticformintNo
ChangedOtherInternationalformintNo
WithAirformintNo
WithHotelformintNo
WithPassiveHotelformintNo
WithCarformintNo
TotalChangedBookingsformintNo
TotalServicesToBookingsformintNo
TotalTicketedBookingsformintNo
TotalTicketsIssuedformintNo
OwningAgencyLocationIDformstringNo

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 //ConsultantPnrActivity 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":[{"Consultant":"String","TransactionAgent":"String","Location":"String","Team":"String","TotalBookings":0,"Domestic":0,"International":0,"Land":0,"Cancelled":0,"Complex":0,"ChangedOwnDomestic":0,"ChangedOwnInternational":0,"ChangedOtherDomestic":0,"ChangedOtherInternational":0,"WithAir":0,"WithHotel":0,"WithPassiveHotel":0,"WithCar":0,"TotalChangedBookings":0,"TotalServicesToBookings":0,"TotalTicketedBookings":0,"TotalTicketsIssued":0,"OwningAgencyLocationID":"String"}],"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}