Agentivity API

GetSafeToGoForwardingLogs

The following routes are available for this service:
All Verbs	/SafeToGoForwardingLogs

**GetSafeToGoForwardingLogs** Parameters:
Name	Parameter	Data Type	Required	Description
LogDateStart	query	string	Yes	Date in format YYYYMMDD
LogDateEnd	query	string	No	Date in format YYYYMMDD
RecordLocator	query	string	No	Record locator
IsSuccess	query	boolean	No	Filter based on outcome
OwningAgencyLocationID	query	string	No	Comma Delimited List of PCCs

**CompanyLevelRequestBase** Parameters:
Name	Parameter	Data Type	Required	Description
OwningCompanyCode	query	string	No	Comma Delimited List of Owning Company Codes
UserName	query	string	No	UserName in form of an email address

**PagingMetadata** Parameters:
Name	Parameter	Data Type	Required	Description
Offset	query	string	No	Starting Record
Limit	query	string	No	Number of records to return (PageSize)
TotalRecords	query	string	No	Total Number of Records in a Full Reponse (if no paging)
ResponseRecords	query	string	No	Total Number of Records in this Reponse (on this page)

**CollectionResponse<TItem>** Parameters:
Name	Parameter	Data Type	Required
ResponseMetadata	form	ResponseMetadata	No
ResponseReport	form	List<ApiRequestPerHour>	No
ResponseError	form	AgentivityError	No

**ResponseMetadata** Parameters:
Name	Parameter	Data Type	Required
Success	form	bool	No
HasCache	form	bool	No
HasPaging	form	bool	No
CacheMetadata	form	CacheMetadata	No
PagingMetadata	form	PagingMetadata	No

**CacheMetadata** Parameters:
Name	Parameter	Data Type	Required
CachedAt	form	DateTime	No
CacheExpiresAt	form	DateTime	No
IsFromCache	form	bool	No

**ApiRequestPerHour** Parameters:
Name	Parameter	Data Type	Required
RequestDate	form	DateTime	No
Hour0	form	int	No
Hour1	form	int	No
Hour2	form	int	No
Hour3	form	int	No
Hour4	form	int	No
Hour5	form	int	No
Hour6	form	int	No
Hour7	form	int	No
Hour8	form	int	No
Hour9	form	int	No
Hour10	form	int	No
Hour11	form	int	No
Hour12	form	int	No
Hour13	form	int	No
Hour14	form	int	No
Hour15	form	int	No
Hour16	form	int	No
Hour17	form	int	No
Hour18	form	int	No
Hour19	form	int	No
Hour20	form	int	No
Hour21	form	int	No
Hour22	form	int	No
Hour23	form	int	No

**AgentivityError** Parameters:
Name	Parameter	Data Type	Required
ErrorCode	form	string	No
Message	form	string	No
StatusCode	form	string	No
VerboseMessage	form	string	No

**SafeToGoForwardingLog** Parameters:
Name	Parameter	Data Type	Required
LogSafeToGoId	form	int	No
RecordLocator	form	string	No
PNRCreationDate	form	DateTime?	No
LogMessage	form	string	No
Success	form	bool	No
CompanyId	form	string	No
OwningAgencyLocationID	form	string	No
RawResponse	form	string	No
LogDateTime	form	DateTime?	No
EventType	form	string	No
Account	form	string	No
AgentivityRef	form	int?	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 /SafeToGoForwardingLogs HTTP/1.1 
Host: api.agentivity.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetSafeToGoForwardingLogs 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>
  <IsSuccess>false</IsSuccess>
  <LogDateEnd>String</LogDateEnd>
  <LogDateStart>String</LogDateStart>
  <OwningAgencyLocationID xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </OwningAgencyLocationID>
  <RecordLocator>String</RecordLocator>
</GetSafeToGoForwardingLogs>

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>
    <SafeToGoForwardingLog>
      <LogSafeToGoId>0</LogSafeToGoId>
      <RecordLocator>String</RecordLocator>
      <PNRCreationDate>0001-01-01T00:00:00</PNRCreationDate>
      <LogMessage>String</LogMessage>
      <Success>false</Success>
      <CompanyId>String</CompanyId>
      <OwningAgencyLocationID>String</OwningAgencyLocationID>
      <RawResponse>String</RawResponse>
      <LogDateTime>0001-01-01T00:00:00</LogDateTime>
      <EventType>String</EventType>
      <Account>String</Account>
      <AgentivityRef>0</AgentivityRef>
    </SafeToGoForwardingLog>
  </ResponseReport>
  <ResponseError>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StatusCode>String</StatusCode>
    <VerboseMessage>String</VerboseMessage>
  </ResponseError>
</AgentivityResponse>