Trendsic Platform Service

<back to all web services

AgentTypeRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
PUT,OPTIONS/v1/Agent/Type
"use strict";
export class QueueDefault {
    /** @param {{LocationId?:string,Services?:string[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    LocationId;
    /** @type {string[]} */
    Services = [];
}
export class Agent {
    /** @param {{AgentId?:number,Company?:string,AgentName?:string,FirstName?:string,LastName?:string,MiddleInitial?:string,Address1?:string,Address2?:string,City?:string,State?:string,Zip?:string,Country?:string,Email?:string,EmailSignature?:string,HomePhone?:string,CellPhone?:string,WorkPhone?:string,InsLicensed?:boolean,AgreeToDisclosures?:boolean,AgreeToDate?:string,PaidDate?:string,AgentNumber?:string,ReferringAgent?:string,PlacementAgent?:string,CreatedDate?:string,UserId?:string,IsAgent?:boolean,Package?:string,StoreName?:string,Notes?:string,Upline1?:number,Upline2?:number,Upline3?:number,Upline4?:number,MVPID?:number,AVPID?:number,RVPID?:number,AgentLevel?:number,IsMVP?:boolean,IsRVP?:boolean,IsAVP?:boolean,IsAdmin?:boolean,IsBusinessCardAdmin?:boolean,TeamName?:string,LocationId?:string,CalendarId?:string,Rank?:string,NBC?:boolean,Upline1Percent?:number,Upline2Percent?:number,Upline3Percent?:number,Upline4Percent?:number,AgentStatus?:string,Office?:string,DOB?:string,SSN?:string,Fax?:string,BusinessEmail?:string,ModifiedDate?:string,ModifiedBy?:string,TimeZone?:string,LeaderLocked?:boolean,LastSubmittedBusinessDate?:string,GracePeriodDate?:string,Vested?:boolean,DirectPay?:string,DirectPayApprBy?:string,FactFinderBilling?:number,FullName?:string,ByLastName?:string,IsSecurityLicensed?:boolean,IsEncompassAdmin?:boolean,ApiKey?:string,LastSessionId?:string,LastLogin?:string,MfaActive?:boolean,RequireMFA?:boolean,SMSPhoneNumber?:string,VerifiedEmailStatus?:boolean,VerifiedCellPhoneStatus?:boolean,SchedulerUrl?:string,QueueDefaults?:QueueDefault,Roles?:string[],PasswordUpdated?:boolean,RestrictToSingleSession?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    AgentId;
    /** @type {string} */
    Company;
    /** @type {string} */
    AgentName;
    /** @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} */
    EmailSignature;
    /** @type {string} */
    HomePhone;
    /** @type {string} */
    CellPhone;
    /** @type {string} */
    WorkPhone;
    /** @type {boolean} */
    InsLicensed;
    /** @type {boolean} */
    AgreeToDisclosures;
    /** @type {?string} */
    AgreeToDate;
    /** @type {?string} */
    PaidDate;
    /** @type {string} */
    AgentNumber;
    /** @type {string} */
    ReferringAgent;
    /** @type {string} */
    PlacementAgent;
    /** @type {?string} */
    CreatedDate;
    /** @type {string} */
    UserId;
    /** @type {boolean} */
    IsAgent;
    /** @type {string} */
    Package;
    /** @type {string} */
    StoreName;
    /** @type {string} */
    Notes;
    /** @type {?number} */
    Upline1;
    /** @type {?number} */
    Upline2;
    /** @type {?number} */
    Upline3;
    /** @type {?number} */
    Upline4;
    /** @type {?number} */
    MVPID;
    /** @type {?number} */
    AVPID;
    /** @type {?number} */
    RVPID;
    /** @type {?number} */
    AgentLevel;
    /** @type {boolean} */
    IsMVP;
    /** @type {boolean} */
    IsRVP;
    /** @type {boolean} */
    IsAVP;
    /** @type {boolean} */
    IsAdmin;
    /** @type {boolean} */
    IsBusinessCardAdmin;
    /** @type {string} */
    TeamName;
    /** @type {string} */
    LocationId;
    /** @type {string} */
    CalendarId;
    /** @type {string} */
    Rank;
    /** @type {boolean} */
    NBC;
    /** @type {?number} */
    Upline1Percent;
    /** @type {?number} */
    Upline2Percent;
    /** @type {?number} */
    Upline3Percent;
    /** @type {?number} */
    Upline4Percent;
    /** @type {string} */
    AgentStatus;
    /** @type {string} */
    Office;
    /** @type {?string} */
    DOB;
    /** @type {string} */
    SSN;
    /** @type {string} */
    Fax;
    /** @type {string} */
    BusinessEmail;
    /** @type {?string} */
    ModifiedDate;
    /** @type {string} */
    ModifiedBy;
    /** @type {string} */
    TimeZone;
    /** @type {boolean} */
    LeaderLocked;
    /** @type {string} */
    LastSubmittedBusinessDate;
    /** @type {string} */
    GracePeriodDate;
    /** @type {boolean} */
    Vested;
    /** @type {string} */
    DirectPay;
    /** @type {string} */
    DirectPayApprBy;
    /** @type {?number} */
    FactFinderBilling;
    /** @type {string} */
    FullName;
    /** @type {string} */
    ByLastName;
    /** @type {boolean} */
    IsSecurityLicensed;
    /** @type {boolean} */
    IsEncompassAdmin;
    /** @type {string} */
    ApiKey;
    /** @type {string} */
    LastSessionId;
    /** @type {?string} */
    LastLogin;
    /** @type {boolean} */
    MfaActive;
    /** @type {boolean} */
    RequireMFA;
    /** @type {string} */
    SMSPhoneNumber;
    /** @type {boolean} */
    VerifiedEmailStatus;
    /** @type {boolean} */
    VerifiedCellPhoneStatus;
    /** @type {string} */
    SchedulerUrl;
    /** @type {QueueDefault} */
    QueueDefaults;
    /** @type {string[]} */
    Roles = [];
    /** @type {boolean} */
    PasswordUpdated;
    /** @type {boolean} */
    RestrictToSingleSession;
}
export class AgentResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Agent?:Agent[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {Agent[]} */
    Agent = [];
}
export class AgentTypeRequest {
    /** @param {{Agent?:Agent,Type?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {Agent} */
    Agent;
    /** @type {string} */
    Type;
}

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

PUT /v1/Agent/Type HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AgentTypeRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Agent>
    <AVPID>0</AVPID>
    <Address1>String</Address1>
    <Address2>String</Address2>
    <AgentId>0</AgentId>
    <AgentLevel>0</AgentLevel>
    <AgentName>String</AgentName>
    <AgentNumber>String</AgentNumber>
    <AgentStatus>String</AgentStatus>
    <AgreeToDate>0001-01-01T00:00:00</AgreeToDate>
    <AgreeToDisclosures>false</AgreeToDisclosures>
    <ApiKey>00000000-0000-0000-0000-000000000000</ApiKey>
    <BusinessEmail>String</BusinessEmail>
    <ByLastName>String</ByLastName>
    <CalendarId>00000000-0000-0000-0000-000000000000</CalendarId>
    <CellPhone>String</CellPhone>
    <City>String</City>
    <Company>String</Company>
    <Country>String</Country>
    <CreatedDate>0001-01-01T00:00:00</CreatedDate>
    <DOB>0001-01-01T00:00:00</DOB>
    <DirectPay>0001-01-01T00:00:00</DirectPay>
    <DirectPayApprBy>String</DirectPayApprBy>
    <Email>String</Email>
    <EmailSignature>String</EmailSignature>
    <FactFinderBilling>0</FactFinderBilling>
    <Fax>String</Fax>
    <FirstName>String</FirstName>
    <FullName>String</FullName>
    <GracePeriodDate>0001-01-01T00:00:00</GracePeriodDate>
    <HomePhone>String</HomePhone>
    <InsLicensed>false</InsLicensed>
    <IsAVP>false</IsAVP>
    <IsAdmin>false</IsAdmin>
    <IsAgent>false</IsAgent>
    <IsBusinessCardAdmin>false</IsBusinessCardAdmin>
    <IsEncompassAdmin>false</IsEncompassAdmin>
    <IsMVP>false</IsMVP>
    <IsRVP>false</IsRVP>
    <IsSecurityLicensed>false</IsSecurityLicensed>
    <LastLogin>0001-01-01T00:00:00</LastLogin>
    <LastName>String</LastName>
    <LastSessionId>String</LastSessionId>
    <LastSubmittedBusinessDate>0001-01-01T00:00:00</LastSubmittedBusinessDate>
    <LeaderLocked>false</LeaderLocked>
    <LocationId>00000000-0000-0000-0000-000000000000</LocationId>
    <MVPID>0</MVPID>
    <MfaActive>false</MfaActive>
    <MiddleInitial>String</MiddleInitial>
    <ModifiedBy>String</ModifiedBy>
    <ModifiedDate>0001-01-01T00:00:00</ModifiedDate>
    <NBC>false</NBC>
    <Notes>String</Notes>
    <Office>String</Office>
    <Package>String</Package>
    <PaidDate>0001-01-01T00:00:00</PaidDate>
    <PasswordUpdated>false</PasswordUpdated>
    <PlacementAgent>String</PlacementAgent>
    <QueueDefaults>
      <LocationId>00000000-0000-0000-0000-000000000000</LocationId>
      <Services xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:guid>00000000-0000-0000-0000-000000000000</d4p1:guid>
      </Services>
    </QueueDefaults>
    <RVPID>0</RVPID>
    <Rank>String</Rank>
    <ReferringAgent>String</ReferringAgent>
    <RequireMFA>false</RequireMFA>
    <RestrictToSingleSession>false</RestrictToSingleSession>
    <Roles xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </Roles>
    <SMSPhoneNumber>String</SMSPhoneNumber>
    <SSN>String</SSN>
    <SchedulerUrl>String</SchedulerUrl>
    <State>String</State>
    <StoreName>String</StoreName>
    <TeamName>String</TeamName>
    <TimeZone>String</TimeZone>
    <Upline1>0</Upline1>
    <Upline1Percent>0</Upline1Percent>
    <Upline2>0</Upline2>
    <Upline2Percent>0</Upline2Percent>
    <Upline3>0</Upline3>
    <Upline3Percent>0</Upline3Percent>
    <Upline4>0</Upline4>
    <Upline4Percent>0</Upline4Percent>
    <UserId>00000000-0000-0000-0000-000000000000</UserId>
    <VerifiedCellPhoneStatus>false</VerifiedCellPhoneStatus>
    <VerifiedEmailStatus>false</VerifiedEmailStatus>
    <Vested>false</Vested>
    <WorkPhone>String</WorkPhone>
    <Zip>String</Zip>
  </Agent>
  <Type>String</Type>
</AgentTypeRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AgentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Agent>
    <Agent>
      <AVPID>0</AVPID>
      <Address1>String</Address1>
      <Address2>String</Address2>
      <AgentId>0</AgentId>
      <AgentLevel>0</AgentLevel>
      <AgentName>String</AgentName>
      <AgentNumber>String</AgentNumber>
      <AgentStatus>String</AgentStatus>
      <AgreeToDate>0001-01-01T00:00:00</AgreeToDate>
      <AgreeToDisclosures>false</AgreeToDisclosures>
      <ApiKey>00000000-0000-0000-0000-000000000000</ApiKey>
      <BusinessEmail>String</BusinessEmail>
      <ByLastName>String</ByLastName>
      <CalendarId>00000000-0000-0000-0000-000000000000</CalendarId>
      <CellPhone>String</CellPhone>
      <City>String</City>
      <Company>String</Company>
      <Country>String</Country>
      <CreatedDate>0001-01-01T00:00:00</CreatedDate>
      <DOB>0001-01-01T00:00:00</DOB>
      <DirectPay>0001-01-01T00:00:00</DirectPay>
      <DirectPayApprBy>String</DirectPayApprBy>
      <Email>String</Email>
      <EmailSignature>String</EmailSignature>
      <FactFinderBilling>0</FactFinderBilling>
      <Fax>String</Fax>
      <FirstName>String</FirstName>
      <FullName>String</FullName>
      <GracePeriodDate>0001-01-01T00:00:00</GracePeriodDate>
      <HomePhone>String</HomePhone>
      <InsLicensed>false</InsLicensed>
      <IsAVP>false</IsAVP>
      <IsAdmin>false</IsAdmin>
      <IsAgent>false</IsAgent>
      <IsBusinessCardAdmin>false</IsBusinessCardAdmin>
      <IsEncompassAdmin>false</IsEncompassAdmin>
      <IsMVP>false</IsMVP>
      <IsRVP>false</IsRVP>
      <IsSecurityLicensed>false</IsSecurityLicensed>
      <LastLogin>0001-01-01T00:00:00</LastLogin>
      <LastName>String</LastName>
      <LastSessionId>String</LastSessionId>
      <LastSubmittedBusinessDate>0001-01-01T00:00:00</LastSubmittedBusinessDate>
      <LeaderLocked>false</LeaderLocked>
      <LocationId>00000000-0000-0000-0000-000000000000</LocationId>
      <MVPID>0</MVPID>
      <MfaActive>false</MfaActive>
      <MiddleInitial>String</MiddleInitial>
      <ModifiedBy>String</ModifiedBy>
      <ModifiedDate>0001-01-01T00:00:00</ModifiedDate>
      <NBC>false</NBC>
      <Notes>String</Notes>
      <Office>String</Office>
      <Package>String</Package>
      <PaidDate>0001-01-01T00:00:00</PaidDate>
      <PasswordUpdated>false</PasswordUpdated>
      <PlacementAgent>String</PlacementAgent>
      <QueueDefaults>
        <LocationId>00000000-0000-0000-0000-000000000000</LocationId>
        <Services xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:guid>00000000-0000-0000-0000-000000000000</d5p1:guid>
        </Services>
      </QueueDefaults>
      <RVPID>0</RVPID>
      <Rank>String</Rank>
      <ReferringAgent>String</ReferringAgent>
      <RequireMFA>false</RequireMFA>
      <RestrictToSingleSession>false</RestrictToSingleSession>
      <Roles xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </Roles>
      <SMSPhoneNumber>String</SMSPhoneNumber>
      <SSN>String</SSN>
      <SchedulerUrl>String</SchedulerUrl>
      <State>String</State>
      <StoreName>String</StoreName>
      <TeamName>String</TeamName>
      <TimeZone>String</TimeZone>
      <Upline1>0</Upline1>
      <Upline1Percent>0</Upline1Percent>
      <Upline2>0</Upline2>
      <Upline2Percent>0</Upline2Percent>
      <Upline3>0</Upline3>
      <Upline3Percent>0</Upline3Percent>
      <Upline4>0</Upline4>
      <Upline4Percent>0</Upline4Percent>
      <UserId>00000000-0000-0000-0000-000000000000</UserId>
      <VerifiedCellPhoneStatus>false</VerifiedCellPhoneStatus>
      <VerifiedEmailStatus>false</VerifiedEmailStatus>
      <Vested>false</Vested>
      <WorkPhone>String</WorkPhone>
      <Zip>String</Zip>
    </Agent>
  </Agent>
  <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>
</AgentResponse>