Trendsic Platform Service

<back to all web services

ListingsRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,POST,PUT,DELETE,OPTIONS/v1/Listings/{ID}
GET,POST,PUT,DELETE,OPTIONS/v1/Listings
GET,POST,PUT,DELETE,OPTIONS/v1/Listings/DateRange/{ParamStartDate}/{ParamEndDate}/{AgentID}
GET,POST,PUT,DELETE,OPTIONS/v1/Listings/DateRange/{ParamStartDate}/{ParamEndDate}
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Listing:
    id: int = 0
    listingdate: datetime.datetime = datetime.datetime(1, 1, 1)
    listingtdate: datetime.datetime = datetime.datetime(1, 1, 1)
    policy: Optional[str] = None
    oagent: Optional[str] = None
    insured: Optional[str] = None
    premium: Optional[str] = None
    part: Optional[str] = None
    amount: Decimal = decimal.Decimal(0)
    agentnm: Optional[str] = None
    listingctype: Optional[str] = None
    company: Optional[str] = None
    approved: Optional[str] = None
    cardcredit: Optional[str] = None
    region: Optional[str] = None
    fpayout: Optional[str] = None
    promopts: Optional[str] = None
    appcnt: Optional[str] = None
    partpercent: Optional[str] = None
    gross: Decimal = decimal.Decimal(0)
    city: Optional[str] = None
    state: Optional[str] = None
    agentno: Optional[str] = None
    type: Optional[str] = None
    commrate: Optional[str] = None
    agent_i_d: int = 0
    o_agent_i_d: int = 0
    fieldpayout: Decimal = decimal.Decimal(0)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ListingsResponse:
    response_status: Optional[ResponseStatus] = None
    listings: List[Listing] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ListingsRequest:
    listings: List[Listing] = field(default_factory=list)
    agent_i_d: int = 0
    param_start_date: datetime.datetime = datetime.datetime(1, 1, 1)
    param_end_date: datetime.datetime = datetime.datetime(1, 1, 1)

Python ListingsRequest DTOs

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

HTTP + XML

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

POST /v1/Listings/{ID} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ListingsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AgentID>0</AgentID>
  <Listings>
    <Listing>
      <AGENTNM>String</AGENTNM>
      <AGENTNO>String</AGENTNO>
      <AMOUNT>0</AMOUNT>
      <APPCNT>String</APPCNT>
      <APPROVED>String</APPROVED>
      <AgentID>0</AgentID>
      <CARDCREDIT>String</CARDCREDIT>
      <CITY>String</CITY>
      <COMMRATE>String</COMMRATE>
      <COMPANY>String</COMPANY>
      <FIELDPAYOUT>0</FIELDPAYOUT>
      <FPAYOUT>String</FPAYOUT>
      <GROSS>0</GROSS>
      <ID>0</ID>
      <INSURED>String</INSURED>
      <LISTINGCTYPE>String</LISTINGCTYPE>
      <LISTINGDATE>0001-01-01T00:00:00</LISTINGDATE>
      <LISTINGTDATE>0001-01-01T00:00:00</LISTINGTDATE>
      <OAGENT>String</OAGENT>
      <OAgentID>0</OAgentID>
      <PART>String</PART>
      <PARTPERCENT>String</PARTPERCENT>
      <POLICY>String</POLICY>
      <PREMIUM>String</PREMIUM>
      <PROMOPTS>String</PROMOPTS>
      <REGION>String</REGION>
      <STATE>String</STATE>
      <TYPE>String</TYPE>
    </Listing>
  </Listings>
  <ParamEndDate>0001-01-01T00:00:00</ParamEndDate>
  <ParamStartDate>0001-01-01T00:00:00</ParamStartDate>
</ListingsRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ListingsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Listings>
    <Listing>
      <AGENTNM>String</AGENTNM>
      <AGENTNO>String</AGENTNO>
      <AMOUNT>0</AMOUNT>
      <APPCNT>String</APPCNT>
      <APPROVED>String</APPROVED>
      <AgentID>0</AgentID>
      <CARDCREDIT>String</CARDCREDIT>
      <CITY>String</CITY>
      <COMMRATE>String</COMMRATE>
      <COMPANY>String</COMPANY>
      <FIELDPAYOUT>0</FIELDPAYOUT>
      <FPAYOUT>String</FPAYOUT>
      <GROSS>0</GROSS>
      <ID>0</ID>
      <INSURED>String</INSURED>
      <LISTINGCTYPE>String</LISTINGCTYPE>
      <LISTINGDATE>0001-01-01T00:00:00</LISTINGDATE>
      <LISTINGTDATE>0001-01-01T00:00:00</LISTINGTDATE>
      <OAGENT>String</OAGENT>
      <OAgentID>0</OAgentID>
      <PART>String</PART>
      <PARTPERCENT>String</PARTPERCENT>
      <POLICY>String</POLICY>
      <PREMIUM>String</PREMIUM>
      <PROMOPTS>String</PROMOPTS>
      <REGION>String</REGION>
      <STATE>String</STATE>
      <TYPE>String</TYPE>
    </Listing>
  </Listings>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</ListingsResponse>