| Requires any of the roles: | Worker, Agent, Administrator, Worker, Agent, Administrator |
| GET | /v1/Agent/{AgentId} | ||
|---|---|---|---|
| GET,POST,PUT,DELETE,OPTIONS | /v1/Agent | ||
| GET | /v1/Agent/ByUserId/{UserId} | ||
| GET,POST,PUT,DELETE,OPTIONS | /v1/Agent/Hierarchy/{ParamGetHierarchy} | ||
| GET,OPTIONS | /v1/Agent/Hierarchy/{ParamGetHierarchy}/{ParamDistinct}/{NewAgents} | ||
| GET,OPTIONS | /v1/Agent/Hierarchy/{ParamGetHierarchy}/{ParamDistinct} |
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;
public class dtos
{
public static class AgentRequest
{
public ArrayList<Agent> Agent = new ArrayList<Agent>();
public Boolean ParamGetHierarchy = null;
public Boolean ParamDistinct = null;
public Boolean NewAgents = null;
public Integer AgentId = null;
public UUID Location = null;
public UUID UserId = null;
public ArrayList<String> Services = new ArrayList<String>();
public ArrayList<Agent> getAgent() { return Agent; }
public AgentRequest setAgent(ArrayList<Agent> value) { this.Agent = value; return this; }
public Boolean isParamGetHierarchy() { return ParamGetHierarchy; }
public AgentRequest setParamGetHierarchy(Boolean value) { this.ParamGetHierarchy = value; return this; }
public Boolean isParamDistinct() { return ParamDistinct; }
public AgentRequest setParamDistinct(Boolean value) { this.ParamDistinct = value; return this; }
public Boolean isNewAgents() { return NewAgents; }
public AgentRequest setNewAgents(Boolean value) { this.NewAgents = value; return this; }
public Integer getAgentId() { return AgentId; }
public AgentRequest setAgentId(Integer value) { this.AgentId = value; return this; }
public UUID getLocation() { return Location; }
public AgentRequest setLocation(UUID value) { this.Location = value; return this; }
public UUID getUserId() { return UserId; }
public AgentRequest setUserId(UUID value) { this.UserId = value; return this; }
public ArrayList<String> getServices() { return Services; }
public AgentRequest setServices(ArrayList<String> value) { this.Services = value; return this; }
}
public static class Agent
{
public Integer AgentId = null;
public String Company = null;
public String AgentName = null;
public String FirstName = null;
public String LastName = null;
public String MiddleInitial = null;
public String Address1 = null;
public String Address2 = null;
public String City = null;
public String State = null;
public String Zip = null;
public String Country = null;
public String Email = null;
public String EmailSignature = null;
public String HomePhone = null;
public String CellPhone = null;
public String WorkPhone = null;
public Boolean InsLicensed = null;
public Boolean AgreeToDisclosures = null;
public Date AgreeToDate = null;
public Date PaidDate = null;
public String AgentNumber = null;
public String ReferringAgent = null;
public String PlacementAgent = null;
public Date CreatedDate = null;
public UUID UserId = null;
public Boolean IsAgent = null;
public String Package = null;
public String StoreName = null;
public String Notes = null;
public Integer Upline1 = null;
public Integer Upline2 = null;
public Integer Upline3 = null;
public Integer Upline4 = null;
public Integer MVPID = null;
public Integer AVPID = null;
public Integer RVPID = null;
public BigDecimal AgentLevel = null;
public Boolean IsMVP = null;
public Boolean IsRVP = null;
public Boolean IsAVP = null;
public Boolean IsAdmin = null;
public Boolean IsBusinessCardAdmin = null;
public String TeamName = null;
public UUID LocationId = null;
public UUID CalendarId = null;
public String Rank = null;
public Boolean NBC = null;
public BigDecimal Upline1Percent = null;
public BigDecimal Upline2Percent = null;
public BigDecimal Upline3Percent = null;
public BigDecimal Upline4Percent = null;
public String AgentStatus = null;
public String Office = null;
public Date DOB = null;
public String SSN = null;
public String Fax = null;
public String BusinessEmail = null;
public Date ModifiedDate = null;
public String ModifiedBy = null;
public String TimeZone = null;
public Boolean LeaderLocked = null;
public Date LastSubmittedBusinessDate = null;
public Date GracePeriodDate = null;
public Boolean Vested = null;
public Date DirectPay = null;
public String DirectPayApprBy = null;
public BigDecimal FactFinderBilling = null;
public String FullName = null;
public String ByLastName = null;
public Boolean IsSecurityLicensed = null;
public Boolean IsEncompassAdmin = null;
public UUID ApiKey = null;
public String LastSessionId = null;
public Date LastLogin = null;
public Boolean MfaActive = null;
public Boolean RequireMFA = null;
public String SMSPhoneNumber = null;
public Boolean VerifiedEmailStatus = null;
public Boolean VerifiedCellPhoneStatus = null;
public String SchedulerUrl = null;
public QueueDefault QueueDefaults = null;
public ArrayList<String> Roles = new ArrayList<String>();
public Boolean PasswordUpdated = null;
public Boolean RestrictToSingleSession = null;
public Integer getAgentId() { return AgentId; }
public Agent setAgentId(Integer value) { this.AgentId = value; return this; }
public String getCompany() { return Company; }
public Agent setCompany(String value) { this.Company = value; return this; }
public String getAgentName() { return AgentName; }
public Agent setAgentName(String value) { this.AgentName = value; return this; }
public String getFirstName() { return FirstName; }
public Agent setFirstName(String value) { this.FirstName = value; return this; }
public String getLastName() { return LastName; }
public Agent setLastName(String value) { this.LastName = value; return this; }
public String getMiddleInitial() { return MiddleInitial; }
public Agent setMiddleInitial(String value) { this.MiddleInitial = value; return this; }
public String getAddress1() { return Address1; }
public Agent setAddress1(String value) { this.Address1 = value; return this; }
public String getAddress2() { return Address2; }
public Agent setAddress2(String value) { this.Address2 = value; return this; }
public String getCity() { return City; }
public Agent setCity(String value) { this.City = value; return this; }
public String getState() { return State; }
public Agent setState(String value) { this.State = value; return this; }
public String getZip() { return Zip; }
public Agent setZip(String value) { this.Zip = value; return this; }
public String getCountry() { return Country; }
public Agent setCountry(String value) { this.Country = value; return this; }
public String getEmail() { return Email; }
public Agent setEmail(String value) { this.Email = value; return this; }
public String getEmailSignature() { return EmailSignature; }
public Agent setEmailSignature(String value) { this.EmailSignature = value; return this; }
public String getHomePhone() { return HomePhone; }
public Agent setHomePhone(String value) { this.HomePhone = value; return this; }
public String getCellPhone() { return CellPhone; }
public Agent setCellPhone(String value) { this.CellPhone = value; return this; }
public String getWorkPhone() { return WorkPhone; }
public Agent setWorkPhone(String value) { this.WorkPhone = value; return this; }
public Boolean isInsLicensed() { return InsLicensed; }
public Agent setInsLicensed(Boolean value) { this.InsLicensed = value; return this; }
public Boolean isAgreeToDisclosures() { return AgreeToDisclosures; }
public Agent setAgreeToDisclosures(Boolean value) { this.AgreeToDisclosures = value; return this; }
public Date getAgreeToDate() { return AgreeToDate; }
public Agent setAgreeToDate(Date value) { this.AgreeToDate = value; return this; }
public Date getPaidDate() { return PaidDate; }
public Agent setPaidDate(Date value) { this.PaidDate = value; return this; }
public String getAgentNumber() { return AgentNumber; }
public Agent setAgentNumber(String value) { this.AgentNumber = value; return this; }
public String getReferringAgent() { return ReferringAgent; }
public Agent setReferringAgent(String value) { this.ReferringAgent = value; return this; }
public String getPlacementAgent() { return PlacementAgent; }
public Agent setPlacementAgent(String value) { this.PlacementAgent = value; return this; }
public Date getCreatedDate() { return CreatedDate; }
public Agent setCreatedDate(Date value) { this.CreatedDate = value; return this; }
public UUID getUserId() { return UserId; }
public Agent setUserId(UUID value) { this.UserId = value; return this; }
public Boolean getIsAgent() { return IsAgent; }
public Agent setIsAgent(Boolean value) { this.IsAgent = value; return this; }
public String getPackage() { return Package; }
public Agent setPackage(String value) { this.Package = value; return this; }
public String getStoreName() { return StoreName; }
public Agent setStoreName(String value) { this.StoreName = value; return this; }
public String getNotes() { return Notes; }
public Agent setNotes(String value) { this.Notes = value; return this; }
public Integer getUpline1() { return Upline1; }
public Agent setUpline1(Integer value) { this.Upline1 = value; return this; }
public Integer getUpline2() { return Upline2; }
public Agent setUpline2(Integer value) { this.Upline2 = value; return this; }
public Integer getUpline3() { return Upline3; }
public Agent setUpline3(Integer value) { this.Upline3 = value; return this; }
public Integer getUpline4() { return Upline4; }
public Agent setUpline4(Integer value) { this.Upline4 = value; return this; }
public Integer getMvpid() { return MVPID; }
public Agent setMvpid(Integer value) { this.MVPID = value; return this; }
public Integer getAvpid() { return AVPID; }
public Agent setAvpid(Integer value) { this.AVPID = value; return this; }
public Integer getRvpid() { return RVPID; }
public Agent setRvpid(Integer value) { this.RVPID = value; return this; }
public BigDecimal getAgentLevel() { return AgentLevel; }
public Agent setAgentLevel(BigDecimal value) { this.AgentLevel = value; return this; }
public Boolean getIsMVP() { return IsMVP; }
public Agent setIsMVP(Boolean value) { this.IsMVP = value; return this; }
public Boolean getIsRVP() { return IsRVP; }
public Agent setIsRVP(Boolean value) { this.IsRVP = value; return this; }
public Boolean getIsAVP() { return IsAVP; }
public Agent setIsAVP(Boolean value) { this.IsAVP = value; return this; }
public Boolean getIsAdmin() { return IsAdmin; }
public Agent setIsAdmin(Boolean value) { this.IsAdmin = value; return this; }
public Boolean getIsBusinessCardAdmin() { return IsBusinessCardAdmin; }
public Agent setIsBusinessCardAdmin(Boolean value) { this.IsBusinessCardAdmin = value; return this; }
public String getTeamName() { return TeamName; }
public Agent setTeamName(String value) { this.TeamName = value; return this; }
public UUID getLocationId() { return LocationId; }
public Agent setLocationId(UUID value) { this.LocationId = value; return this; }
public UUID getCalendarId() { return CalendarId; }
public Agent setCalendarId(UUID value) { this.CalendarId = value; return this; }
public String getRank() { return Rank; }
public Agent setRank(String value) { this.Rank = value; return this; }
public Boolean isNbc() { return NBC; }
public Agent setNbc(Boolean value) { this.NBC = value; return this; }
public BigDecimal getUpline1Percent() { return Upline1Percent; }
public Agent setUpline1Percent(BigDecimal value) { this.Upline1Percent = value; return this; }
public BigDecimal getUpline2Percent() { return Upline2Percent; }
public Agent setUpline2Percent(BigDecimal value) { this.Upline2Percent = value; return this; }
public BigDecimal getUpline3Percent() { return Upline3Percent; }
public Agent setUpline3Percent(BigDecimal value) { this.Upline3Percent = value; return this; }
public BigDecimal getUpline4Percent() { return Upline4Percent; }
public Agent setUpline4Percent(BigDecimal value) { this.Upline4Percent = value; return this; }
public String getAgentStatus() { return AgentStatus; }
public Agent setAgentStatus(String value) { this.AgentStatus = value; return this; }
public String getOffice() { return Office; }
public Agent setOffice(String value) { this.Office = value; return this; }
public Date getDob() { return DOB; }
public Agent setDob(Date value) { this.DOB = value; return this; }
public String getSsn() { return SSN; }
public Agent setSsn(String value) { this.SSN = value; return this; }
public String getFax() { return Fax; }
public Agent setFax(String value) { this.Fax = value; return this; }
public String getBusinessEmail() { return BusinessEmail; }
public Agent setBusinessEmail(String value) { this.BusinessEmail = value; return this; }
public Date getModifiedDate() { return ModifiedDate; }
public Agent setModifiedDate(Date value) { this.ModifiedDate = value; return this; }
public String getModifiedBy() { return ModifiedBy; }
public Agent setModifiedBy(String value) { this.ModifiedBy = value; return this; }
public String getTimeZone() { return TimeZone; }
public Agent setTimeZone(String value) { this.TimeZone = value; return this; }
public Boolean isLeaderLocked() { return LeaderLocked; }
public Agent setLeaderLocked(Boolean value) { this.LeaderLocked = value; return this; }
public Date getLastSubmittedBusinessDate() { return LastSubmittedBusinessDate; }
public Agent setLastSubmittedBusinessDate(Date value) { this.LastSubmittedBusinessDate = value; return this; }
public Date getGracePeriodDate() { return GracePeriodDate; }
public Agent setGracePeriodDate(Date value) { this.GracePeriodDate = value; return this; }
public Boolean isVested() { return Vested; }
public Agent setVested(Boolean value) { this.Vested = value; return this; }
public Date getDirectPay() { return DirectPay; }
public Agent setDirectPay(Date value) { this.DirectPay = value; return this; }
public String getDirectPayApprBy() { return DirectPayApprBy; }
public Agent setDirectPayApprBy(String value) { this.DirectPayApprBy = value; return this; }
public BigDecimal getFactFinderBilling() { return FactFinderBilling; }
public Agent setFactFinderBilling(BigDecimal value) { this.FactFinderBilling = value; return this; }
public String getFullName() { return FullName; }
public Agent setFullName(String value) { this.FullName = value; return this; }
public String getByLastName() { return ByLastName; }
public Agent setByLastName(String value) { this.ByLastName = value; return this; }
public Boolean getIsSecurityLicensed() { return IsSecurityLicensed; }
public Agent setIsSecurityLicensed(Boolean value) { this.IsSecurityLicensed = value; return this; }
public Boolean getIsEncompassAdmin() { return IsEncompassAdmin; }
public Agent setIsEncompassAdmin(Boolean value) { this.IsEncompassAdmin = value; return this; }
public UUID getApiKey() { return ApiKey; }
public Agent setApiKey(UUID value) { this.ApiKey = value; return this; }
public String getLastSessionId() { return LastSessionId; }
public Agent setLastSessionId(String value) { this.LastSessionId = value; return this; }
public Date getLastLogin() { return LastLogin; }
public Agent setLastLogin(Date value) { this.LastLogin = value; return this; }
public Boolean isMfaActive() { return MfaActive; }
public Agent setMfaActive(Boolean value) { this.MfaActive = value; return this; }
public Boolean isRequireMFA() { return RequireMFA; }
public Agent setRequireMFA(Boolean value) { this.RequireMFA = value; return this; }
public String getSmsPhoneNumber() { return SMSPhoneNumber; }
public Agent setSmsPhoneNumber(String value) { this.SMSPhoneNumber = value; return this; }
public Boolean isVerifiedEmailStatus() { return VerifiedEmailStatus; }
public Agent setVerifiedEmailStatus(Boolean value) { this.VerifiedEmailStatus = value; return this; }
public Boolean isVerifiedCellPhoneStatus() { return VerifiedCellPhoneStatus; }
public Agent setVerifiedCellPhoneStatus(Boolean value) { this.VerifiedCellPhoneStatus = value; return this; }
public String getSchedulerUrl() { return SchedulerUrl; }
public Agent setSchedulerUrl(String value) { this.SchedulerUrl = value; return this; }
public QueueDefault getQueueDefaults() { return QueueDefaults; }
public Agent setQueueDefaults(QueueDefault value) { this.QueueDefaults = value; return this; }
public ArrayList<String> getRoles() { return Roles; }
public Agent setRoles(ArrayList<String> value) { this.Roles = value; return this; }
public Boolean isPasswordUpdated() { return PasswordUpdated; }
public Agent setPasswordUpdated(Boolean value) { this.PasswordUpdated = value; return this; }
public Boolean isRestrictToSingleSession() { return RestrictToSingleSession; }
public Agent setRestrictToSingleSession(Boolean value) { this.RestrictToSingleSession = value; return this; }
}
public static class QueueDefault
{
public UUID LocationId = null;
public ArrayList<UUID> Services = new ArrayList<UUID>();
public UUID getLocationId() { return LocationId; }
public QueueDefault setLocationId(UUID value) { this.LocationId = value; return this; }
public ArrayList<UUID> getServices() { return Services; }
public QueueDefault setServices(ArrayList<UUID> value) { this.Services = value; return this; }
}
public static class AgentResponse
{
public ResponseStatus ResponseStatus = null;
public ArrayList<Agent> Agent = new ArrayList<Agent>();
public ResponseStatus getResponseStatus() { return ResponseStatus; }
public AgentResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
public ArrayList<Agent> getAgent() { return Agent; }
public AgentResponse setAgent(ArrayList<Agent> value) { this.Agent = value; return this; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/Agent HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
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-01,
PaidDate: 0001-01-01,
AgentNumber: String,
ReferringAgent: String,
PlacementAgent: String,
CreatedDate: 0001-01-01,
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-01,
SSN: String,
Fax: String,
BusinessEmail: String,
ModifiedDate: 0001-01-01,
ModifiedBy: String,
TimeZone: String,
LeaderLocked: False,
LastSubmittedBusinessDate: 0001-01-01,
GracePeriodDate: 0001-01-01,
Vested: False,
DirectPay: 0001-01-01,
DirectPayApprBy: String,
FactFinderBilling: 0,
FullName: String,
ByLastName: String,
IsSecurityLicensed: False,
IsEncompassAdmin: False,
ApiKey: 00000000000000000000000000000000,
LastSessionId: String,
LastLogin: 0001-01-01,
MfaActive: False,
RequireMFA: False,
SMSPhoneNumber: String,
VerifiedEmailStatus: False,
VerifiedCellPhoneStatus: False,
SchedulerUrl: String,
QueueDefaults:
{
LocationId: 00000000000000000000000000000000,
Services:
[
00000000000000000000000000000000
]
},
Roles:
[
String
],
PasswordUpdated: False,
RestrictToSingleSession: False
}
],
ParamGetHierarchy: False,
ParamDistinct: False,
NewAgents: False,
AgentId: 0,
Location: 00000000000000000000000000000000,
UserId: 00000000000000000000000000000000,
Services:
[
String
]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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-01,
PaidDate: 0001-01-01,
AgentNumber: String,
ReferringAgent: String,
PlacementAgent: String,
CreatedDate: 0001-01-01,
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-01,
SSN: String,
Fax: String,
BusinessEmail: String,
ModifiedDate: 0001-01-01,
ModifiedBy: String,
TimeZone: String,
LeaderLocked: False,
LastSubmittedBusinessDate: 0001-01-01,
GracePeriodDate: 0001-01-01,
Vested: False,
DirectPay: 0001-01-01,
DirectPayApprBy: String,
FactFinderBilling: 0,
FullName: String,
ByLastName: String,
IsSecurityLicensed: False,
IsEncompassAdmin: False,
ApiKey: 00000000000000000000000000000000,
LastSessionId: String,
LastLogin: 0001-01-01,
MfaActive: False,
RequireMFA: False,
SMSPhoneNumber: String,
VerifiedEmailStatus: False,
VerifiedCellPhoneStatus: False,
SchedulerUrl: String,
QueueDefaults:
{
LocationId: 00000000000000000000000000000000,
Services:
[
00000000000000000000000000000000
]
},
Roles:
[
String
],
PasswordUpdated: False,
RestrictToSingleSession: False
}
]
}