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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<GetAgencyReviewPerAccount xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="schemas.agentivity.com/types">
  <Limit>String</Limit>
  <Offset>String</Offset>
  <ResponseRecords>0</ResponseRecords>
  <TotalRecords>0</TotalRecords>
  <OwningCompanyCode xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </OwningCompanyCode>
  <UserName>String</UserName>
  <IncludeAfterHoursServicingFields>false</IncludeAfterHoursServicingFields>
  <OwningAgencyLocationID xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </OwningAgencyLocationID>
  <PNRCreationDateEnd>String</PNRCreationDateEnd>
  <PNRCreationDateStart>String</PNRCreationDateStart>
</GetAgencyReviewPerAccount>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AgentivityResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="schemas.agentivity.com/types">
  <ResponseMetadata>
    <Success>false</Success>
    <HasCache>false</HasCache>
    <HasPaging>false</HasPaging>
    <CacheMetadata>
      <IsFromCache>false</IsFromCache>
      <CachedAt>0001-01-01T00:00:00</CachedAt>
      <CacheExpiresAt>0001-01-01T00:00:00</CacheExpiresAt>
    </CacheMetadata>
    <PagingMetadata>
      <Limit>String</Limit>
      <Offset>String</Offset>
      <ResponseRecords>0</ResponseRecords>
      <TotalRecords>0</TotalRecords>
    </PagingMetadata>
  </ResponseMetadata>
  <ResponseReport>
    <AccountSummary>
      <Account>String</Account>
      <TicketedBookings>0</TicketedBookings>
      <LCCTktBookings>0</LCCTktBookings>
      <AssumedTicketedBookings>0</AssumedTicketedBookings>
      <NonTicketedBookings>0</NonTicketedBookings>
      <CxlBookings>0</CxlBookings>
      <NonAirBookings>0</NonAirBookings>
      <TotalBookings>0</TotalBookings>
      <OnlineBookings>0</OnlineBookings>
      <AverageItineraryChanges>0</AverageItineraryChanges>
      <TotalItineraryChanges>0</TotalItineraryChanges>
      <TotalItineraryChangesBeforeTicketing>0</TotalItineraryChangesBeforeTicketing>
      <TotalItineraryChangesAfterTicketing>0</TotalItineraryChangesAfterTicketing>
      <CarbonTonnage>0</CarbonTonnage>
    </AccountSummary>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>