Agentivity API

<back to all web services

GetAgencyReviewPerAccount

The following routes are available for this service:
All Verbs/AgencyReviewPerAccount
GetAgencyReviewPerAccount Parameters:
NameParameterData TypeRequiredDescription
PNRCreationDateStartquerystringYesDate in format YYYYMMDD
PNRCreationDateEndquerystringYesDate in format YYYYMMDD
OwningAgencyLocationIDquerystringNoComma Delimited List of PCCs
IncludeAfterHoursServicingFieldsquerystringNoIncludes AfterHours Servicing in results
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
AccountSummaryReview Parameters:
NameParameterData TypeRequiredDescription
AccountformstringNo
TicketedBookingsformintNo
LCCTktBookingsformintNo
AssumedTicketedBookingsformintNo
NonTicketedBookingsformintNo
CxlBookingsformintNo
NonAirBookingsformintNo
TotalBookingsformintNo
OnlineBookingsformintNo
AverageItineraryChangesformdecimalNo
TotalItineraryChangesformdecimalNo
TotalItineraryChangesBeforeTicketingformintNo
TotalItineraryChangesAfterTicketingformintNo
CarbonTonnageformdouble?No

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.

POST //AgencyReviewPerAccount HTTP/1.1 
Host: api.agentivity.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"PNRCreationDateStart":"String","PNRCreationDateEnd":"String","OwningAgencyLocationID":["String"],"IncludeAfterHoursServicingFields":false,"OwningCompanyCode":["String"],"UserName":"String","Offset":"String","Limit":"String","TotalRecords":0,"ResponseRecords":0}
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":[{"Account":"String","TicketedBookings":0,"LCCTktBookings":0,"AssumedTicketedBookings":0,"NonTicketedBookings":0,"CxlBookings":0,"NonAirBookings":0,"TotalBookings":0,"OnlineBookings":0,"AverageItineraryChanges":0,"TotalItineraryChanges":0,"TotalItineraryChangesBeforeTicketing":0,"TotalItineraryChangesAfterTicketing":0,"CarbonTonnage":0}],"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}