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}
import Foundation
import ServiceStack

public class ListingSummaryRequest : Codable
{
    public var listingSummary:[ListingSummary] = []
    public var agentID:Int
    public var paramStartDate:Date
    public var paramEndDate:Date

    required public init(){}
}

public class ListingSummary : Codable
{
    public var agentLevel:Double
    public var agentPoints:String
    public var agentPolicyNumbers:String
    public var agentYTDTotal:Double
    public var agentRTotal:Double
    public var agentOverallTotal:Double
    public var agentNextLevelPrerequired:Double
    public var agentCurrentYTDTotal:Double
    public var agentCurrentRunningTotal:Double
    public var agentLevelCalculatedFromListingPart:Double
    public var agentRequiredBeforeNextLevel:Double
    public var agentAdjustmentTotal:Double
    public var agentCommissionSubtotal:Double
    public var agentBalanceForward:Double

    required public init(){}
}

public class ListingSummaryResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var listingSummary:[ListingSummary] = []

    required public init(){}
}


Swift ListingSummaryRequest DTOs

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 /v1/ListingSummary/{ID} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
Content-Type: application/json
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: application/json
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}]}