Trendsic Platform Service

PeraAgentRequest

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

The following routes are available for this service:
GET,OPTIONS	/v1/PeraAgent/{AgentId}
PUT,OPTIONS	/v1/PeraAgent

**PeraAgentRequest** Parameters:
Name	Parameter	Data Type	Required	Description
AgentId	path	int	No
Agent	body	List<PeraAgent>	No

**PeraAgent** Parameters:
Name	Parameter	Data Type	Required
AgentId	form	int	No
UserId	form	Guid	No
FirstName	form	string	No
LastName	form	string	No
FullName	form	string	No
CalendarId	form	Guid	No
GoogleCalendar	form	string	No
PeraICSUrl	form	string	No
AsapOptOut	form	bool	No
AsapLockOut	form	bool	No
AcceptAllAppts	form	bool	No
TimeZone	form	string	No
Email	form	string	No
AsapWeeklyAppts	form	int	No
SaturdayAppts	form	bool	No
SundayAppts	form	bool	No
AgentLevel	form	int	No
Districts	form	List<AgentDistrict>	No
ApiKey	form	Guid	No

**AgentDistrict** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
AgentId	form	int	No
DistrictId	form	int	No
Name	form	string	No
CampaignTypeId	form	int	No

**AgentResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No
Agent	form	List<Agent>	No

**Agent** Parameters:
Name	Parameter	Data Type	Required
AgentId	form	int	No
Company	form	string	No
AgentName	form	string	No
FirstName	form	string	No
LastName	form	string	No
MiddleInitial	form	string	No
Address1	form	string	No
Address2	form	string	No
City	form	string	No
State	form	string	No
Zip	form	string	No
Country	form	string	No
Email	form	string	No
EmailSignature	form	string	No
HomePhone	form	string	No
CellPhone	form	string	No
WorkPhone	form	string	No
InsLicensed	form	bool	No
AgreeToDisclosures	form	bool	No
AgreeToDate	form	DateTime?	No
PaidDate	form	DateTime?	No
AgentNumber	form	string	No
ReferringAgent	form	string	No
PlacementAgent	form	string	No
CreatedDate	form	DateTime?	No
UserId	form	Guid	No
IsAgent	form	bool	No
Package	form	string	No
StoreName	form	string	No
Notes	form	string	No
Upline1	form	int?	No
Upline2	form	int?	No
Upline3	form	int?	No
Upline4	form	int?	No
MVPID	form	int?	No
AVPID	form	int?	No
RVPID	form	int?	No
AgentLevel	form	decimal?	No
IsMVP	form	bool	No
IsRVP	form	bool	No
IsAVP	form	bool	No
IsAdmin	form	bool	No
IsBusinessCardAdmin	form	bool	No
TeamName	form	string	No
LocationId	form	Guid	No
CalendarId	form	Guid	No
Rank	form	string	No
NBC	form	bool	No
Upline1Percent	form	decimal?	No
Upline2Percent	form	decimal?	No
Upline3Percent	form	decimal?	No
Upline4Percent	form	decimal?	No
AgentStatus	form	string	No
Office	form	string	No
DOB	form	DateTime?	No
SSN	form	string	No
Fax	form	string	No
BusinessEmail	form	string	No
ModifiedDate	form	DateTime?	No
ModifiedBy	form	string	No
TimeZone	form	string	No
LeaderLocked	form	bool	No
LastSubmittedBusinessDate	form	DateTime	No
GracePeriodDate	form	DateTime	No
Vested	form	bool	No
DirectPay	form	DateTime	No
DirectPayApprBy	form	string	No
FactFinderBilling	form	decimal?	No
FullName	form	string	No
ByLastName	form	string	No
IsSecurityLicensed	form	bool	No
IsEncompassAdmin	form	bool	No
ApiKey	form	Guid	No
LastSessionId	form	string	No
LastLogin	form	DateTime?	No
MfaActive	form	bool	No
RequireMFA	form	bool	No
SMSPhoneNumber	form	string	No
VerifiedEmailStatus	form	bool	No
VerifiedCellPhoneStatus	form	bool	No
SchedulerUrl	form	string	No
QueueDefaults	form	QueueDefault	No
Roles	form	List<string>	No
PasswordUpdated	form	bool	No
RestrictToSingleSession	form	bool	No

**QueueDefault** Parameters:
Name	Parameter	Data Type	Required	Description
LocationId	form	Guid	No
Services	form	List<Guid>	No

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

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /v1/PeraAgent/{AgentId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"AgentId":0,"Agent":[{"AgentId":0,"UserId":"00000000000000000000000000000000","FirstName":"String","LastName":"String","FullName":"String","CalendarId":"00000000000000000000000000000000","GoogleCalendar":"String","PeraICSUrl":"String","AsapOptOut":false,"AsapLockOut":false,"AcceptAllAppts":false,"TimeZone":"String","Email":"String","AsapWeeklyAppts":0,"SaturdayAppts":false,"SundayAppts":false,"AgentLevel":0,"Districts":[{"Id":0,"AgentId":0,"DistrictId":0,"Name":"String","CampaignTypeId":0}],"ApiKey":"00000000000000000000000000000000"}]}

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}]}