Trendsic Platform Service

PeraAgentRequest

**Requires Authentication**
Requires any of the roles:	Agent, Administrator, Agent, Administrator

The following routes are available for this service:
GET,OPTIONS	/v1/PeraAgent/{AgentId}
PUT,OPTIONS	/v1/PeraAgent

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 QueueDefault() = 
        member val LocationId:Guid = new Guid() with get,set
        member val Services:ResizeArray<Guid> = new ResizeArray<Guid>() with get,set

    [<AllowNullLiteral>]
    type Agent() = 
        member val AgentId:Int32 = new Int32() with get,set
        member val Company:String = null with get,set
        member val AgentName:String = null with get,set
        member val FirstName:String = null with get,set
        member val LastName:String = null with get,set
        member val MiddleInitial:String = null with get,set
        member val Address1:String = null with get,set
        member val Address2:String = null with get,set
        member val City:String = null with get,set
        member val State:String = null with get,set
        member val Zip:String = null with get,set
        member val Country:String = null with get,set
        member val Email:String = null with get,set
        member val EmailSignature:String = null with get,set
        member val HomePhone:String = null with get,set
        member val CellPhone:String = null with get,set
        member val WorkPhone:String = null with get,set
        member val InsLicensed:Boolean = new Boolean() with get,set
        member val AgreeToDisclosures:Boolean = new Boolean() with get,set
        member val AgreeToDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val PaidDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val AgentNumber:String = null with get,set
        member val ReferringAgent:String = null with get,set
        member val PlacementAgent:String = null with get,set
        member val CreatedDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val UserId:Guid = new Guid() with get,set
        member val IsAgent:Boolean = new Boolean() with get,set
        member val Package:String = null with get,set
        member val StoreName:String = null with get,set
        member val Notes:String = null with get,set
        member val Upline1:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Upline2:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Upline3:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Upline4:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val MVPID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val AVPID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val RVPID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val AgentLevel:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val IsMVP:Boolean = new Boolean() with get,set
        member val IsRVP:Boolean = new Boolean() with get,set
        member val IsAVP:Boolean = new Boolean() with get,set
        member val IsAdmin:Boolean = new Boolean() with get,set
        member val IsBusinessCardAdmin:Boolean = new Boolean() with get,set
        member val TeamName:String = null with get,set
        member val LocationId:Guid = new Guid() with get,set
        member val CalendarId:Guid = new Guid() with get,set
        member val Rank:String = null with get,set
        member val NBC:Boolean = new Boolean() with get,set
        member val Upline1Percent:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val Upline2Percent:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val Upline3Percent:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val Upline4Percent:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val AgentStatus:String = null with get,set
        member val Office:String = null with get,set
        member val DOB:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val SSN:String = null with get,set
        member val Fax:String = null with get,set
        member val BusinessEmail:String = null with get,set
        member val ModifiedDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val ModifiedBy:String = null with get,set
        member val TimeZone:String = null with get,set
        member val LeaderLocked:Boolean = new Boolean() with get,set
        member val LastSubmittedBusinessDate:DateTime = new DateTime() with get,set
        member val GracePeriodDate:DateTime = new DateTime() with get,set
        member val Vested:Boolean = new Boolean() with get,set
        member val DirectPay:DateTime = new DateTime() with get,set
        member val DirectPayApprBy:String = null with get,set
        member val FactFinderBilling:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val FullName:String = null with get,set
        member val ByLastName:String = null with get,set
        member val IsSecurityLicensed:Boolean = new Boolean() with get,set
        member val IsEncompassAdmin:Boolean = new Boolean() with get,set
        member val ApiKey:Guid = new Guid() with get,set
        member val LastSessionId:String = null with get,set
        member val LastLogin:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val MfaActive:Boolean = new Boolean() with get,set
        member val RequireMFA:Boolean = new Boolean() with get,set
        member val SMSPhoneNumber:String = null with get,set
        member val VerifiedEmailStatus:Boolean = new Boolean() with get,set
        member val VerifiedCellPhoneStatus:Boolean = new Boolean() with get,set
        member val SchedulerUrl:String = null with get,set
        member val QueueDefaults:QueueDefault = null with get,set
        member val Roles:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val PasswordUpdated:Boolean = new Boolean() with get,set
        member val RestrictToSingleSession:Boolean = new Boolean() with get,set

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

    [<AllowNullLiteral>]
    type AgentDistrict() = 
        member val Id:Int32 = new Int32() with get,set
        member val AgentId:Int32 = new Int32() with get,set
        member val DistrictId:Int32 = new Int32() with get,set
        member val Name:String = null with get,set
        member val CampaignTypeId:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type PeraAgent() = 
        member val AgentId:Int32 = new Int32() with get,set
        member val UserId:Guid = new Guid() with get,set
        member val FirstName:String = null with get,set
        member val LastName:String = null with get,set
        member val FullName:String = null with get,set
        member val CalendarId:Guid = new Guid() with get,set
        member val GoogleCalendar:String = null with get,set
        member val PeraICSUrl:String = null with get,set
        member val AsapOptOut:Boolean = new Boolean() with get,set
        member val AsapLockOut:Boolean = new Boolean() with get,set
        member val AcceptAllAppts:Boolean = new Boolean() with get,set
        member val TimeZone:String = null with get,set
        member val Email:String = null with get,set
        member val AsapWeeklyAppts:Int32 = new Int32() with get,set
        member val SaturdayAppts:Boolean = new Boolean() with get,set
        member val SundayAppts:Boolean = new Boolean() with get,set
        member val AgentLevel:Int32 = new Int32() with get,set
        member val Districts:ResizeArray<AgentDistrict> = new ResizeArray<AgentDistrict>() with get,set
        member val ApiKey:Guid = new Guid() with get,set

    [<AllowNullLiteral>]
    type PeraAgentRequest() = 
        member val AgentId:Int32 = new Int32() with get,set
        member val Agent:ResizeArray<PeraAgent> = new ResizeArray<PeraAgent>() with get,set

F# PeraAgentRequest 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/PeraAgent/{AgentId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PeraAgentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Agent>
    <PeraAgent>
      <AcceptAllAppts>false</AcceptAllAppts>
      <AgentId>0</AgentId>
      <AgentLevel>0</AgentLevel>
      <ApiKey>00000000-0000-0000-0000-000000000000</ApiKey>
      <AsapLockOut>false</AsapLockOut>
      <AsapOptOut>false</AsapOptOut>
      <AsapWeeklyAppts>0</AsapWeeklyAppts>
      <CalendarId>00000000-0000-0000-0000-000000000000</CalendarId>
      <Districts>
        <AgentDistrict>
          <AgentId>0</AgentId>
          <CampaignTypeId>0</CampaignTypeId>
          <DistrictId>0</DistrictId>
          <Id>0</Id>
          <Name>String</Name>
        </AgentDistrict>
      </Districts>
      <Email>String</Email>
      <FirstName>String</FirstName>
      <FullName>String</FullName>
      <GoogleCalendar>String</GoogleCalendar>
      <LastName>String</LastName>
      <PeraICSUrl>String</PeraICSUrl>
      <SaturdayAppts>false</SaturdayAppts>
      <SundayAppts>false</SundayAppts>
      <TimeZone>String</TimeZone>
      <UserId>00000000-0000-0000-0000-000000000000</UserId>
    </PeraAgent>
  </Agent>
  <AgentId>0</AgentId>
</PeraAgentRequest>

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>