Trendsic Platform Service

AgentDistrictIdRequest

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

The following routes are available for this service:
GET,OPTIONS	/v1/DistrictAgents/{DistrictId}

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class AgentDistrictIdRequest
{
    open var DistrictId:Int? = null
}

open class AgentDistrictIdResponse
{
    open var ResponseStatus:ResponseStatus? = null
    open var Agents:ArrayList<Agent> = ArrayList<Agent>()
}

open class Agent
{
    open var AgentId:Int? = null
    open var Company:String? = null
    open var AgentName:String? = null
    open var FirstName:String? = null
    open var LastName:String? = null
    open var MiddleInitial:String? = null
    open var Address1:String? = null
    open var Address2:String? = null
    open var City:String? = null
    open var State:String? = null
    open var Zip:String? = null
    open var Country:String? = null
    open var Email:String? = null
    open var EmailSignature:String? = null
    open var HomePhone:String? = null
    open var CellPhone:String? = null
    open var WorkPhone:String? = null
    open var InsLicensed:Boolean? = null
    open var AgreeToDisclosures:Boolean? = null
    open var AgreeToDate:Date? = null
    open var PaidDate:Date? = null
    open var AgentNumber:String? = null
    open var ReferringAgent:String? = null
    open var PlacementAgent:String? = null
    open var CreatedDate:Date? = null
    open var UserId:UUID? = null
    open var IsAgent:Boolean? = null
    open var Package:String? = null
    open var StoreName:String? = null
    open var Notes:String? = null
    open var Upline1:Int? = null
    open var Upline2:Int? = null
    open var Upline3:Int? = null
    open var Upline4:Int? = null
    open var MVPID:Int? = null
    open var AVPID:Int? = null
    open var RVPID:Int? = null
    open var AgentLevel:BigDecimal? = null
    open var IsMVP:Boolean? = null
    open var IsRVP:Boolean? = null
    open var IsAVP:Boolean? = null
    open var IsAdmin:Boolean? = null
    open var IsBusinessCardAdmin:Boolean? = null
    open var TeamName:String? = null
    open var LocationId:UUID? = null
    open var CalendarId:UUID? = null
    open var Rank:String? = null
    open var NBC:Boolean? = null
    open var Upline1Percent:BigDecimal? = null
    open var Upline2Percent:BigDecimal? = null
    open var Upline3Percent:BigDecimal? = null
    open var Upline4Percent:BigDecimal? = null
    open var AgentStatus:String? = null
    open var Office:String? = null
    open var DOB:Date? = null
    open var SSN:String? = null
    open var Fax:String? = null
    open var BusinessEmail:String? = null
    open var ModifiedDate:Date? = null
    open var ModifiedBy:String? = null
    open var TimeZone:String? = null
    open var LeaderLocked:Boolean? = null
    open var LastSubmittedBusinessDate:Date? = null
    open var GracePeriodDate:Date? = null
    open var Vested:Boolean? = null
    open var DirectPay:Date? = null
    open var DirectPayApprBy:String? = null
    open var FactFinderBilling:BigDecimal? = null
    open var FullName:String? = null
    open var ByLastName:String? = null
    open var IsSecurityLicensed:Boolean? = null
    open var IsEncompassAdmin:Boolean? = null
    open var ApiKey:UUID? = null
    open var LastSessionId:String? = null
    open var LastLogin:Date? = null
    open var MfaActive:Boolean? = null
    open var RequireMFA:Boolean? = null
    open var SMSPhoneNumber:String? = null
    open var VerifiedEmailStatus:Boolean? = null
    open var VerifiedCellPhoneStatus:Boolean? = null
    open var SchedulerUrl:String? = null
    open var QueueDefaults:QueueDefault? = null
    open var Roles:ArrayList<String> = ArrayList<String>()
    open var PasswordUpdated:Boolean? = null
    open var RestrictToSingleSession:Boolean? = null
}

open class QueueDefault
{
    open var LocationId:UUID? = null
    open var Services:ArrayList<UUID> = ArrayList<UUID>()
}

Kotlin AgentDistrictIdRequest 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/DistrictAgents/{DistrictId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

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

<AgentDistrictIdResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Agents>
    <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>
  </Agents>
  <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>
</AgentDistrictIdResponse>