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}
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type ListingSummary() = 
        member val AgentLevel:Decimal = new Decimal() with get,set
        member val AgentPoints:String = null with get,set
        member val AgentPolicyNumbers:String = null with get,set
        member val AgentYTDTotal:Decimal = new Decimal() with get,set
        member val AgentRTotal:Decimal = new Decimal() with get,set
        member val AgentOverallTotal:Decimal = new Decimal() with get,set
        member val AgentNextLevelPrerequired:Decimal = new Decimal() with get,set
        member val AgentCurrentYTDTotal:Decimal = new Decimal() with get,set
        member val AgentCurrentRunningTotal:Decimal = new Decimal() with get,set
        member val AgentLevelCalculatedFromListingPart:Decimal = new Decimal() with get,set
        member val AgentRequiredBeforeNextLevel:Decimal = new Decimal() with get,set
        member val AgentAdjustmentTotal:Decimal = new Decimal() with get,set
        member val AgentCommissionSubtotal:Decimal = new Decimal() with get,set
        member val AgentBalanceForward:Decimal = new Decimal() with get,set

    [<AllowNullLiteral>]
    type ListingSummaryResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val ListingSummary:ResizeArray<ListingSummary> = new ResizeArray<ListingSummary>() with get,set

    [<AllowNullLiteral>]
    type ListingSummaryRequest() = 
        member val ListingSummary:ResizeArray<ListingSummary> = new ResizeArray<ListingSummary>() with get,set
        member val AgentID:Int32 = new Int32() with get,set
        member val ParamStartDate:DateTime = new DateTime() with get,set
        member val ParamEndDate:DateTime = new DateTime() with get,set

F# ListingSummaryRequest DTOs

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