| Requires any of the roles: | Worker, Agent, Administrator |
| GET | /v1/AgentCRM/{AgentId} |
|---|
export class QueueDefault
{
public LocationId: string;
public Services: string[] = [];
public constructor(init?: Partial<QueueDefault>) { (Object as any).assign(this, init); }
}
export class Agent
{
public AgentId: number;
public Company: string;
public AgentName: string;
public FirstName: string;
public LastName: string;
public MiddleInitial: string;
public Address1: string;
public Address2: string;
public City: string;
public State: string;
public Zip: string;
public Country: string;
public Email: string;
public EmailSignature: string;
public HomePhone: string;
public CellPhone: string;
public WorkPhone: string;
public InsLicensed: boolean;
public AgreeToDisclosures: boolean;
public AgreeToDate?: string;
public PaidDate?: string;
public AgentNumber: string;
public ReferringAgent: string;
public PlacementAgent: string;
public CreatedDate?: string;
public UserId: string;
public IsAgent: boolean;
public Package: string;
public StoreName: string;
public Notes: string;
public Upline1?: number;
public Upline2?: number;
public Upline3?: number;
public Upline4?: number;
public MVPID?: number;
public AVPID?: number;
public RVPID?: number;
public AgentLevel?: number;
public IsMVP: boolean;
public IsRVP: boolean;
public IsAVP: boolean;
public IsAdmin: boolean;
public IsBusinessCardAdmin: boolean;
public TeamName: string;
public LocationId: string;
public CalendarId: string;
public Rank: string;
public NBC: boolean;
public Upline1Percent?: number;
public Upline2Percent?: number;
public Upline3Percent?: number;
public Upline4Percent?: number;
public AgentStatus: string;
public Office: string;
public DOB?: string;
public SSN: string;
public Fax: string;
public BusinessEmail: string;
public ModifiedDate?: string;
public ModifiedBy: string;
public TimeZone: string;
public LeaderLocked: boolean;
public LastSubmittedBusinessDate: string;
public GracePeriodDate: string;
public Vested: boolean;
public DirectPay: string;
public DirectPayApprBy: string;
public FactFinderBilling?: number;
public FullName: string;
public ByLastName: string;
public IsSecurityLicensed: boolean;
public IsEncompassAdmin: boolean;
public ApiKey: string;
public LastSessionId: string;
public LastLogin?: string;
public MfaActive: boolean;
public RequireMFA: boolean;
public SMSPhoneNumber: string;
public VerifiedEmailStatus: boolean;
public VerifiedCellPhoneStatus: boolean;
public SchedulerUrl: string;
public QueueDefaults: QueueDefault;
public Roles: string[] = [];
public PasswordUpdated: boolean;
public RestrictToSingleSession: boolean;
public constructor(init?: Partial<Agent>) { (Object as any).assign(this, init); }
}
export class AgentResponse
{
public ResponseStatus: ResponseStatus;
public Agent: Agent[] = [];
public constructor(init?: Partial<AgentResponse>) { (Object as any).assign(this, init); }
}
export class AgentCRMRequest
{
public AgentId: number;
public constructor(init?: Partial<AgentCRMRequest>) { (Object as any).assign(this, init); }
}
TypeScript AgentCRMRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /v1/AgentCRM/{AgentId} HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
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>