Agentivity API

<back to all web services

GetAccounts

The following routes are available for this service:
All Verbs/Accounts
GetAccounts Parameters:
NameParameterData TypeRequiredDescription
IncludeOwningAgencyLocationsquerybooleanNoIncludes Owning Agency Locations for Accounts in the Result
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)
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
AgencyAccount Parameters:
NameParameterData TypeRequiredDescription
IDformstringNo
NameformstringNo
ManagerformstringNo
CreationDateTimeformDateTime?No
OwningAgencyLocationsformAgencyAccountOwningAgencyLocation[]No
CompanyIdformintNo
LastMatchedDateformDateTime?No
AgencyAccountOwningAgencyLocation Parameters:
NameParameterData TypeRequiredDescription
IDformstringNo
LastMatchedDateformDateTime?No
Report<TItemResponse, TItem> Parameters:
NameParameterData TypeRequiredDescription
ItemformTItemNo

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 //Accounts HTTP/1.1 
Host: api.agentivity.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"IncludeOwningAgencyLocations":false,"OwningAgencyLocationID":["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":{"Item":{"ID":"String","Name":"String","Manager":"String","CreationDateTime":"\/Date(-62135596800000-0000)\/","OwningAgencyLocations":[{"ID":"String","LastMatchedDate":"\/Date(-62135596800000-0000)\/"}],"CompanyId":0,"LastMatchedDate":"\/Date(-62135596800000-0000)\/"}},"ResponseError":{"ErrorCode":"String","Message":"String","StatusCode":"String","VerboseMessage":"String"}}