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
"use strict";
export class AgentRecruit {
    /** @param {{Rank?:string,AgentLevel?:string,UL1FirstName?:string,UL1MiddleName?:string,UL1LastName?:string,UL2FirstName?:string,UL2MiddleName?:string,UL2LastName?:string,UL3FirstName?:string,UL3MiddleName?:string,UL3LastName?:string,UL4FirstName?:string,UL4MiddleName?:string,UL4LastName?:string,Company?:string,FirstName?:string,LastName?:string,MiddleInitial?:string,Address1?:string,Address2?:string,City?:string,State?:string,Zip?:string,Country?:string,Email?:string,HomePhone?:string,CellPhone?:string,WorkPhone?:string,AgentNumber?:string,PlacementAgentName?:string,PlacementAgent?:string,CreatedDate?:string,Level?:string,LastLoginDate?:string,Package?:string,AppCount?:number,Cashflow?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Rank;
    /** @type {string} */
    AgentLevel;
    /** @type {string} */
    UL1FirstName;
    /** @type {string} */
    UL1MiddleName;
    /** @type {string} */
    UL1LastName;
    /** @type {string} */
    UL2FirstName;
    /** @type {string} */
    UL2MiddleName;
    /** @type {string} */
    UL2LastName;
    /** @type {string} */
    UL3FirstName;
    /** @type {string} */
    UL3MiddleName;
    /** @type {string} */
    UL3LastName;
    /** @type {string} */
    UL4FirstName;
    /** @type {string} */
    UL4MiddleName;
    /** @type {string} */
    UL4LastName;
    /** @type {string} */
    Company;
    /** @type {string} */
    FirstName;
    /** @type {string} */
    LastName;
    /** @type {string} */
    MiddleInitial;
    /** @type {string} */
    Address1;
    /** @type {string} */
    Address2;
    /** @type {string} */
    City;
    /** @type {string} */
    State;
    /** @type {string} */
    Zip;
    /** @type {string} */
    Country;
    /** @type {string} */
    Email;
    /** @type {string} */
    HomePhone;
    /** @type {string} */
    CellPhone;
    /** @type {string} */
    WorkPhone;
    /** @type {string} */
    AgentNumber;
    /** @type {string} */
    PlacementAgentName;
    /** @type {string} */
    PlacementAgent;
    /** @type {string} */
    CreatedDate;
    /** @type {string} */
    Level;
    /** @type {string} */
    LastLoginDate;
    /** @type {string} */
    Package;
    /** @type {number} */
    AppCount;
    /** @type {number} */
    Cashflow;
}
export class AgentRecruitResponse {
    /** @param {{ResponseStatus?:ResponseStatus,AgentRecruit?:AgentRecruit[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {AgentRecruit[]} */
    AgentRecruit = [];
}
export class AgentRecruitRequest {
    /** @param {{AgentRecruit?:AgentRecruit[],StartDate?:string,EndDate?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {AgentRecruit[]} */
    AgentRecruit = [];
    /** @type {string} */
    StartDate;
    /** @type {string} */
    EndDate;
}

JavaScript 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>