Agentivity API

<back to all web services

GetMirGenerationLogs

The following routes are available for this service:
GET/MirGenerationLogs
GetMirGenerationLogs Parameters:
NameParameterData TypeRequiredDescription
AccountquerystringNoComma Delimited List of Accounts
UserNamequerystringYesUserName in form of an email address
LogDateStartquerystringYesDate in format YYYYMMDD
LogDateEndquerystringNoDate in format YYYYMMDD
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)
ItemResponse<TItem, TReport> Parameters:
NameParameterData TypeRequiredDescription
ResponseMetadataformResponseMetadataNo
ResponseReportformTReportNo
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
MirGenerationLog Parameters:
NameParameterData TypeRequiredDescription
AgentivityRefformintNo
RecordLocatorformstringNo
PNRCreationDateformDateTimeNo
OwningAgencyLocationIDformstringNo
AccountformstringNo
SuccessformboolNo
ResultMessageformstringNo
EventTypeformstringNo
EventTypeDescformstringNo
OwningConsultantformstringNo
SiteIdformint?No
SiteNameformstringNo
SiteQueueformstringNo
DateTimeSentformDateTimeNo
Report<TItemResponse, TItem> Parameters:
NameParameterData TypeRequiredDescription
ItemformTItemNo

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 //MirGenerationLogs 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>
    <Item>
      <AgentivityRef>0</AgentivityRef>
      <RecordLocator>String</RecordLocator>
      <PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
      <OwningAgencyLocationID>String</OwningAgencyLocationID>
      <Account>String</Account>
      <Success>false</Success>
      <ResultMessage>String</ResultMessage>
      <EventType>String</EventType>
      <EventTypeDesc>String</EventTypeDesc>
      <OwningConsultant>String</OwningConsultant>
      <SiteId>0</SiteId>
      <SiteName>String</SiteName>
      <SiteQueue>String</SiteQueue>
      <DateTimeSent>0001-01-01T00:00:00</DateTimeSent>
    </Item>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>