Trendsic Platform Service

<back to all web services

ListingSummaryRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,POST,PUT,DELETE,OPTIONS/v1/ListingSummary/{ID}
GET,POST,PUT,DELETE,OPTIONS/v1/ListingSummary
GET,POST,PUT,DELETE,OPTIONS/v1/ListingSummary/DateRange/{ParamStartDate}/{ParamEndDate}/{AgentID}
GET,POST,PUT,DELETE,OPTIONS/v1/ListingSummary/DateRange/{ParamStartDate}/{ParamEndDate}
ListingSummaryRequest Parameters:
NameParameterData TypeRequiredDescription
ListingSummarybodyList<ListingSummary>No
AgentIDpathintNo
ParamStartDatepathDateTimeNo
ParamEndDatepathDateTimeNo
ListingSummary Parameters:
NameParameterData TypeRequiredDescription
AgentLevelformdecimalNo
AgentPointsformstringNo
AgentPolicyNumbersformstringNo
AgentYTDTotalformdecimalNo
AgentRTotalformdecimalNo
AgentOverallTotalformdecimalNo
AgentNextLevelPrerequiredformdecimalNo
AgentCurrentYTDTotalformdecimalNo
AgentCurrentRunningTotalformdecimalNo
AgentLevelCalculatedFromListingPartformdecimalNo
AgentRequiredBeforeNextLevelformdecimalNo
AgentAdjustmentTotalformdecimalNo
AgentCommissionSubtotalformdecimalNo
AgentBalanceForwardformdecimalNo
ListingSummaryResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ListingSummaryformList<ListingSummary>No

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

HTTP + OTHER

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

POST /v1/ListingSummary/{ID} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"ListingSummary":[{"AgentLevel":0,"AgentPoints":"String","AgentPolicyNumbers":"String","AgentYTDTotal":0,"AgentRTotal":0,"AgentOverallTotal":0,"AgentNextLevelPrerequired":0,"AgentCurrentYTDTotal":0,"AgentCurrentRunningTotal":0,"AgentLevelCalculatedFromListingPart":0,"AgentRequiredBeforeNextLevel":0,"AgentAdjustmentTotal":0,"AgentCommissionSubtotal":0,"AgentBalanceForward":0}],"AgentID":0,"ParamStartDate":"0001-01-01T00:00:00.0000000","ParamEndDate":"0001-01-01T00:00:00.0000000"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"ListingSummary":[{"AgentLevel":0,"AgentPoints":"String","AgentPolicyNumbers":"String","AgentYTDTotal":0,"AgentRTotal":0,"AgentOverallTotal":0,"AgentNextLevelPrerequired":0,"AgentCurrentYTDTotal":0,"AgentCurrentRunningTotal":0,"AgentLevelCalculatedFromListingPart":0,"AgentRequiredBeforeNextLevel":0,"AgentAdjustmentTotal":0,"AgentCommissionSubtotal":0,"AgentBalanceForward":0}]}