| 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 .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Agent":[{"AgentId":0,"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":false,"AgreeToDisclosures":false,"AgreeToDate":"0001-01-01T00:00:00.0000000","PaidDate":"0001-01-01T00:00:00.0000000","AgentNumber":"String","ReferringAgent":"String","PlacementAgent":"String","CreatedDate":"0001-01-01T00:00:00.0000000","UserId":"00000000000000000000000000000000","IsAgent":false,"Package":"String","StoreName":"String","Notes":"String","Upline1":0,"Upline2":0,"Upline3":0,"Upline4":0,"MVPID":0,"AVPID":0,"RVPID":0,"AgentLevel":0,"IsMVP":false,"IsRVP":false,"IsAVP":false,"IsAdmin":false,"IsBusinessCardAdmin":false,"TeamName":"String","LocationId":"00000000000000000000000000000000","CalendarId":"00000000000000000000000000000000","Rank":"String","NBC":false,"Upline1Percent":0,"Upline2Percent":0,"Upline3Percent":0,"Upline4Percent":0,"AgentStatus":"String","Office":"String","DOB":"0001-01-01T00:00:00.0000000","SSN":"String","Fax":"String","BusinessEmail":"String","ModifiedDate":"0001-01-01T00:00:00.0000000","ModifiedBy":"String","TimeZone":"String","LeaderLocked":false,"LastSubmittedBusinessDate":"0001-01-01T00:00:00.0000000","GracePeriodDate":"0001-01-01T00:00:00.0000000","Vested":false,"DirectPay":"0001-01-01T00:00:00.0000000","DirectPayApprBy":"String","FactFinderBilling":0,"FullName":"String","ByLastName":"String","IsSecurityLicensed":false,"IsEncompassAdmin":false,"ApiKey":"00000000000000000000000000000000","LastSessionId":"String","LastLogin":"0001-01-01T00:00:00.0000000","MfaActive":false,"RequireMFA":false,"SMSPhoneNumber":"String","VerifiedEmailStatus":false,"VerifiedCellPhoneStatus":false,"SchedulerUrl":"String","QueueDefaults":{"LocationId":"00000000000000000000000000000000","Services":["00000000000000000000000000000000"]},"Roles":["String"],"PasswordUpdated":false,"RestrictToSingleSession":false}]}