Agentivity API

<back to all web services

StatsCompaniesPNRs

The following routes are available for this service:
All Verbs/StatsCompaniesPNRs
StatsCompaniesPNRs Parameters:
NameParameterData TypeRequiredDescription
UserNamequerystringNo
DateStartquerystringNo
DateEndquerystringNo
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
StatsCompanyPNR Parameters:
NameParameterData TypeRequiredDescription
CompanyIDformintNo
CompanyNameformstringNo
Yearformint?No
Monthformint?No
DistinctCreatedPNRsformint?No
TotalPNRsProcessedformint?No
ProductTierKformint?No
InvoiceCurrencyformstringNo
UsesGalileoformboolNo
UsesApolloformboolNo
UsesAmadeusformboolNo
UsesSabreformboolNo
DistributorformstringNo
HomeCountryCodeformstringNo

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 //StatsCompaniesPNRs HTTP/1.1 
Host: api.agentivity.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<StatsCompaniesPNRs 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>
  <DateEnd>String</DateEnd>
  <DateStart>String</DateStart>
  <UserName>String</UserName>
</StatsCompaniesPNRs>
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>
    <StatsCompanyPNR>
      <CompanyID>0</CompanyID>
      <CompanyName>String</CompanyName>
      <Year>0</Year>
      <Month>0</Month>
      <DistinctCreatedPNRs>0</DistinctCreatedPNRs>
      <TotalPNRsProcessed>0</TotalPNRsProcessed>
      <ProductTierK>0</ProductTierK>
      <InvoiceCurrency>String</InvoiceCurrency>
      <UsesGalileo>false</UsesGalileo>
      <UsesApollo>false</UsesApollo>
      <UsesAmadeus>false</UsesAmadeus>
      <UsesSabre>false</UsesSabre>
      <Distributor>String</Distributor>
      <HomeCountryCode>String</HomeCountryCode>
    </StatsCompanyPNR>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>