Agentivity API

<back to all web services

GetTrees4TravelForwardingLogs

The following routes are available for this service:
All Verbs/Trees4TravelForwardingLogs
GetTrees4TravelForwardingLogs Parameters:
NameParameterData TypeRequiredDescription
LogDateStartquerystringYesDate in format YYYYMMDD
LogDateEndquerystringNoDate in format YYYYMMDD
RecordLocatorquerystringNoRecord locator
IsSuccessquerybooleanNoFilter based on outcome
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
Trees4TravelForwardingLog Parameters:
NameParameterData TypeRequiredDescription
LogIDformintNo
RecordLocatorformstringNo
PNRCreationDateformDateTime?No
LogMessageformstringNo
SuccessformboolNo
CompanyIdformstringNo
OwningAgencyLocationIDformstringNo
LogDateTimeformDateTime?No
AccountformstringNo
AgentivityRefformint?No

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST //Trees4TravelForwardingLogs HTTP/1.1 
Host: api.agentivity.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"LogDateStart":"String","LogDateEnd":"String","RecordLocator":"String","IsSuccess":false,"OwningAgencyLocationID":["String"],"OwningCompanyCode":["String"],"UserName":"String","Offset":"String","Limit":"String","TotalRecords":0,"ResponseRecords":0}
HTTP/1.1 200 OK
Content-Type: application/json
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":[{"LogID":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"}}