Trendsic Platform Service

<back to all web services

AgentRecruitRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/AgentRecruit
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 AgentRecruit:
    rank: Optional[str] = None
    agent_level: Optional[str] = None
    u_l1_first_name: Optional[str] = None
    u_l1_middle_name: Optional[str] = None
    u_l1_last_name: Optional[str] = None
    u_l2_first_name: Optional[str] = None
    u_l2_middle_name: Optional[str] = None
    u_l2_last_name: Optional[str] = None
    u_l3_first_name: Optional[str] = None
    u_l3_middle_name: Optional[str] = None
    u_l3_last_name: Optional[str] = None
    u_l4_first_name: Optional[str] = None
    u_l4_middle_name: Optional[str] = None
    u_l4_last_name: Optional[str] = None
    company: Optional[str] = None
    first_name: Optional[str] = None
    last_name: Optional[str] = None
    middle_initial: Optional[str] = None
    address1: Optional[str] = None
    address2: Optional[str] = None
    city: Optional[str] = None
    state: Optional[str] = None
    zip: Optional[str] = None
    country: Optional[str] = None
    email: Optional[str] = None
    home_phone: Optional[str] = None
    cell_phone: Optional[str] = None
    work_phone: Optional[str] = None
    agent_number: Optional[str] = None
    placement_agent_name: Optional[str] = None
    placement_agent: Optional[str] = None
    created_date: datetime.datetime = datetime.datetime(1, 1, 1)
    level: Optional[str] = None
    last_login_date: datetime.datetime = datetime.datetime(1, 1, 1)
    package: Optional[str] = None
    app_count: Decimal = decimal.Decimal(0)
    cashflow: Decimal = decimal.Decimal(0)


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


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AgentRecruitRequest:
    agent_recruit: List[AgentRecruit] = field(default_factory=list)
    start_date: datetime.datetime = datetime.datetime(1, 1, 1)
    end_date: datetime.datetime = datetime.datetime(1, 1, 1)

Python AgentRecruitRequest 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.

GET /v1/AgentRecruit HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AgentRecruitResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AgentRecruit>
    <AgentRecruit>
      <Address1>String</Address1>
      <Address2>String</Address2>
      <AgentLevel>String</AgentLevel>
      <AgentNumber>String</AgentNumber>
      <AppCount>0</AppCount>
      <Cashflow>0</Cashflow>
      <CellPhone>String</CellPhone>
      <City>String</City>
      <Company>String</Company>
      <Country>String</Country>
      <CreatedDate>0001-01-01T00:00:00</CreatedDate>
      <Email>String</Email>
      <FirstName>String</FirstName>
      <HomePhone>String</HomePhone>
      <LastLoginDate>0001-01-01T00:00:00</LastLoginDate>
      <LastName>String</LastName>
      <Level>0</Level>
      <MiddleInitial>String</MiddleInitial>
      <Package>String</Package>
      <PlacementAgent>String</PlacementAgent>
      <PlacementAgentName>String</PlacementAgentName>
      <Rank>String</Rank>
      <State>String</State>
      <UL1FirstName>String</UL1FirstName>
      <UL1LastName>String</UL1LastName>
      <UL1MiddleName>String</UL1MiddleName>
      <UL2FirstName>String</UL2FirstName>
      <UL2LastName>String</UL2LastName>
      <UL2MiddleName>String</UL2MiddleName>
      <UL3FirstName>String</UL3FirstName>
      <UL3LastName>String</UL3LastName>
      <UL3MiddleName>String</UL3MiddleName>
      <UL4FirstName>String</UL4FirstName>
      <UL4LastName>String</UL4LastName>
      <UL4MiddleName>String</UL4MiddleName>
      <WorkPhone>String</WorkPhone>
      <Zip>String</Zip>
    </AgentRecruit>
  </AgentRecruit>
  <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>
</AgentRecruitResponse>