Agentivity API

<back to all web services

GetTicketAutomationSuccessPerPCC

The following routes are available for this service:
GET/TicketAutomationSuccessPerPCC
GetTicketAutomationSuccessPerPCC Parameters:
NameParameterData TypeRequiredDescription
DateStartquerystringYesDate in format YYYYMMDD
DateEndquerystringYesDate in format YYYYMMDD
IncludeFailureReasonsquerybooleanNoIncludes failure reasons
OwningAgencyLocationIDquerystringNoComma Delimited List of PCCs
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
TicketAutomationSuccessPerPCC Parameters:
NameParameterData TypeRequiredDescription
OwningAgencyPseudoformstringNo
TotalTicketedPNRsformint?No
ConsultantformstringNo
Requestedformint?No
Successformint?No
Failedformint?No
FailureReasonsformList<TicketAutomationSuccessFailureReason>No
FailureReasonsInternalformstringNo
TicketAutomationSuccessFailureReason Parameters:
NameParameterData TypeRequiredDescription
ValueformstringNo

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.

GET //TicketAutomationSuccessPerPCC HTTP/1.1 
Host: api.agentivity.com 
Accept: application/xml
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>
    <TicketAutomationSuccessPerPCC>
      <OwningAgencyPseudo>String</OwningAgencyPseudo>
      <TotalTicketedPNRs>0</TotalTicketedPNRs>
      <Consultant>String</Consultant>
      <Requested>0</Requested>
      <Success>0</Success>
      <Failed>0</Failed>
      <FailureReasons>
        <Reason>
          <Value>String</Value>
        </Reason>
      </FailureReasons>
      <FailureReasonsInternal>String</FailureReasonsInternal>
    </TicketAutomationSuccessPerPCC>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>