Agentivity API

GetSosForwardingLogs

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

**GetSosForwardingLogs** 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
SosServiceID	query	string	Yes	SOS Service ID (valid values are: ISOS, CR24)

**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<TItem>	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

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

**SosForwardingLog** Parameters:
Name	Parameter	Data Type	Required
LogIsosId	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
LogDateTime	form	DateTime?	No
Account	form	string	No
AgentivityRef	form	int?	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST //SosForwardingLogs HTTP/1.1 
Host: api.agentivity.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"LogDateStart":"String","LogDateEnd":"String","RecordLocator":"String","IsSuccess":false,"OwningAgencyLocationID":["String"],"SosServiceID":"String","OwningCompanyCode":["String"],"UserName":"String","Offset":"String","Limit":"String","TotalRecords":0,"ResponseRecords":0}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ResponseMetadata":{"Success":false,"HasCache":false,"HasPaging":false,"CacheMetadata":{"IsFromCache":false,"CachedAt":"\/Date(-62135596800000-0000)\/","CacheExpiresAt":"\/Date(-62135596800000-0000)\/"},"PagingMetadata":{"Offset":"String","Limit":"String","TotalRecords":0,"ResponseRecords":0}},"ResponseReport":[{"LogIsosId":0,"RecordLocator":"String","PNRCreationDate":"\/Date(-62135596800000-0000)\/","LogMessage":"String","Success":false,"CompanyId":"String","OwningAgencyLocationID":"String","LogDateTime":"\/Date(-62135596800000-0000)\/","Account":"String","AgentivityRef":0}],"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}