| Requires any of the roles: | Agent, Administrator |
| PUT,OPTIONS | /v1/Agent/Type |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueueDefault:
location_id: Optional[str] = None
services: List[str] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Agent:
agent_id: int = 0
company: Optional[str] = None
agent_name: Optional[str] = None
first_name: Optional[str] = None
last_name: Optional[str] = None
middle_initial: Optional[str] = None
address1: Optional[str] = None
address2: Optional[str] = None
city: Optional[str] = None
state: Optional[str] = None
zip: Optional[str] = None
country: Optional[str] = None
email: Optional[str] = None
email_signature: Optional[str] = None
home_phone: Optional[str] = None
cell_phone: Optional[str] = None
work_phone: Optional[str] = None
ins_licensed: bool = False
agree_to_disclosures: bool = False
agree_to_date: Optional[datetime.datetime] = None
paid_date: Optional[datetime.datetime] = None
agent_number: Optional[str] = None
referring_agent: Optional[str] = None
placement_agent: Optional[str] = None
created_date: Optional[datetime.datetime] = None
user_id: Optional[str] = None
is_agent: bool = False
package: Optional[str] = None
store_name: Optional[str] = None
notes: Optional[str] = None
upline1: Optional[int] = None
upline2: Optional[int] = None
upline3: Optional[int] = None
upline4: Optional[int] = None
mvpid: Optional[int] = None
avpid: Optional[int] = None
rvpid: Optional[int] = None
agent_level: Optional[Decimal] = None
is_m_v_p: bool = False
is_r_v_p: bool = False
is_a_v_p: bool = False
is_admin: bool = False
is_business_card_admin: bool = False
team_name: Optional[str] = None
location_id: Optional[str] = None
calendar_id: Optional[str] = None
rank: Optional[str] = None
nbc: bool = False
upline1_percent: Optional[Decimal] = None
upline2_percent: Optional[Decimal] = None
upline3_percent: Optional[Decimal] = None
upline4_percent: Optional[Decimal] = None
agent_status: Optional[str] = None
office: Optional[str] = None
dob: Optional[datetime.datetime] = None
ssn: Optional[str] = None
fax: Optional[str] = None
business_email: Optional[str] = None
modified_date: Optional[datetime.datetime] = None
modified_by: Optional[str] = None
time_zone: Optional[str] = None
leader_locked: bool = False
last_submitted_business_date: datetime.datetime = datetime.datetime(1, 1, 1)
grace_period_date: datetime.datetime = datetime.datetime(1, 1, 1)
vested: bool = False
direct_pay: datetime.datetime = datetime.datetime(1, 1, 1)
direct_pay_appr_by: Optional[str] = None
fact_finder_billing: Optional[Decimal] = None
full_name: Optional[str] = None
by_last_name: Optional[str] = None
is_security_licensed: bool = False
is_encompass_admin: bool = False
api_key: Optional[str] = None
last_session_id: Optional[str] = None
last_login: Optional[datetime.datetime] = None
mfa_active: bool = False
require_m_f_a: bool = False
sms_phone_number: Optional[str] = None
verified_email_status: bool = False
verified_cell_phone_status: bool = False
scheduler_url: Optional[str] = None
queue_defaults: Optional[QueueDefault] = None
roles: List[str] = field(default_factory=list)
password_updated: bool = False
restrict_to_single_session: bool = False
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AgentResponse:
response_status: Optional[ResponseStatus] = None
agent: List[Agent] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AgentTypeRequest:
agent: Optional[Agent] = None
type: Optional[str] = None
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /v1/Agent/Type HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsonl
Content-Type: text/jsonl
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-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},"Type":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
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}]}