| Requires any of the roles: | Agent, Administrator |
| GET,OPTIONS | /v1/DistrictAgents/{DistrictId} |
|---|
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';
class QueueDefault implements IConvertible
{
String? LocationId;
List<String>? Services = [];
QueueDefault({this.LocationId,this.Services});
QueueDefault.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
LocationId = json['LocationId'];
Services = JsonConverters.fromJson(json['Services'],'List<String>',context!);
return this;
}
Map<String, dynamic> toJson() => {
'LocationId': LocationId,
'Services': JsonConverters.toJson(Services,'List<String>',context!)
};
getTypeName() => "QueueDefault";
TypeContext? context = _ctx;
}
class Agent implements IConvertible
{
int? AgentId;
String? 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;
bool? InsLicensed;
bool? AgreeToDisclosures;
DateTime? AgreeToDate;
DateTime? PaidDate;
String? AgentNumber;
String? ReferringAgent;
String? PlacementAgent;
DateTime? CreatedDate;
String? UserId;
bool? IsAgent;
String? Package;
String? StoreName;
String? Notes;
int? Upline1;
int? Upline2;
int? Upline3;
int? Upline4;
int? MVPID;
int? AVPID;
int? RVPID;
double? AgentLevel;
bool? IsMVP;
bool? IsRVP;
bool? IsAVP;
bool? IsAdmin;
bool? IsBusinessCardAdmin;
String? TeamName;
String? LocationId;
String? CalendarId;
String? Rank;
bool? NBC;
double? Upline1Percent;
double? Upline2Percent;
double? Upline3Percent;
double? Upline4Percent;
String? AgentStatus;
String? Office;
DateTime? DOB;
String? SSN;
String? Fax;
String? BusinessEmail;
DateTime? ModifiedDate;
String? ModifiedBy;
String? TimeZone;
bool? LeaderLocked;
DateTime? LastSubmittedBusinessDate;
DateTime? GracePeriodDate;
bool? Vested;
DateTime? DirectPay;
String? DirectPayApprBy;
double? FactFinderBilling;
String? FullName;
String? ByLastName;
bool? IsSecurityLicensed;
bool? IsEncompassAdmin;
String? ApiKey;
String? LastSessionId;
DateTime? LastLogin;
bool? MfaActive;
bool? RequireMFA;
String? SMSPhoneNumber;
bool? VerifiedEmailStatus;
bool? VerifiedCellPhoneStatus;
String? SchedulerUrl;
QueueDefault? QueueDefaults;
List<String>? Roles = [];
bool? PasswordUpdated;
bool? RestrictToSingleSession;
Agent({this.AgentId,this.Company,this.AgentName,this.FirstName,this.LastName,this.MiddleInitial,this.Address1,this.Address2,this.City,this.State,this.Zip,this.Country,this.Email,this.EmailSignature,this.HomePhone,this.CellPhone,this.WorkPhone,this.InsLicensed,this.AgreeToDisclosures,this.AgreeToDate,this.PaidDate,this.AgentNumber,this.ReferringAgent,this.PlacementAgent,this.CreatedDate,this.UserId,this.IsAgent,this.Package,this.StoreName,this.Notes,this.Upline1,this.Upline2,this.Upline3,this.Upline4,this.MVPID,this.AVPID,this.RVPID,this.AgentLevel,this.IsMVP,this.IsRVP,this.IsAVP,this.IsAdmin,this.IsBusinessCardAdmin,this.TeamName,this.LocationId,this.CalendarId,this.Rank,this.NBC,this.Upline1Percent,this.Upline2Percent,this.Upline3Percent,this.Upline4Percent,this.AgentStatus,this.Office,this.DOB,this.SSN,this.Fax,this.BusinessEmail,this.ModifiedDate,this.ModifiedBy,this.TimeZone,this.LeaderLocked,this.LastSubmittedBusinessDate,this.GracePeriodDate,this.Vested,this.DirectPay,this.DirectPayApprBy,this.FactFinderBilling,this.FullName,this.ByLastName,this.IsSecurityLicensed,this.IsEncompassAdmin,this.ApiKey,this.LastSessionId,this.LastLogin,this.MfaActive,this.RequireMFA,this.SMSPhoneNumber,this.VerifiedEmailStatus,this.VerifiedCellPhoneStatus,this.SchedulerUrl,this.QueueDefaults,this.Roles,this.PasswordUpdated,this.RestrictToSingleSession});
Agent.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
AgentId = json['AgentId'];
Company = json['Company'];
AgentName = json['AgentName'];
FirstName = json['FirstName'];
LastName = json['LastName'];
MiddleInitial = json['MiddleInitial'];
Address1 = json['Address1'];
Address2 = json['Address2'];
City = json['City'];
State = json['State'];
Zip = json['Zip'];
Country = json['Country'];
Email = json['Email'];
EmailSignature = json['EmailSignature'];
HomePhone = json['HomePhone'];
CellPhone = json['CellPhone'];
WorkPhone = json['WorkPhone'];
InsLicensed = json['InsLicensed'];
AgreeToDisclosures = json['AgreeToDisclosures'];
AgreeToDate = JsonConverters.fromJson(json['AgreeToDate'],'DateTime',context!);
PaidDate = JsonConverters.fromJson(json['PaidDate'],'DateTime',context!);
AgentNumber = json['AgentNumber'];
ReferringAgent = json['ReferringAgent'];
PlacementAgent = json['PlacementAgent'];
CreatedDate = JsonConverters.fromJson(json['CreatedDate'],'DateTime',context!);
UserId = json['UserId'];
IsAgent = json['IsAgent'];
Package = json['Package'];
StoreName = json['StoreName'];
Notes = json['Notes'];
Upline1 = json['Upline1'];
Upline2 = json['Upline2'];
Upline3 = json['Upline3'];
Upline4 = json['Upline4'];
MVPID = json['MVPID'];
AVPID = json['AVPID'];
RVPID = json['RVPID'];
AgentLevel = JsonConverters.toDouble(json['AgentLevel']);
IsMVP = json['IsMVP'];
IsRVP = json['IsRVP'];
IsAVP = json['IsAVP'];
IsAdmin = json['IsAdmin'];
IsBusinessCardAdmin = json['IsBusinessCardAdmin'];
TeamName = json['TeamName'];
LocationId = json['LocationId'];
CalendarId = json['CalendarId'];
Rank = json['Rank'];
NBC = json['NBC'];
Upline1Percent = JsonConverters.toDouble(json['Upline1Percent']);
Upline2Percent = JsonConverters.toDouble(json['Upline2Percent']);
Upline3Percent = JsonConverters.toDouble(json['Upline3Percent']);
Upline4Percent = JsonConverters.toDouble(json['Upline4Percent']);
AgentStatus = json['AgentStatus'];
Office = json['Office'];
DOB = JsonConverters.fromJson(json['DOB'],'DateTime',context!);
SSN = json['SSN'];
Fax = json['Fax'];
BusinessEmail = json['BusinessEmail'];
ModifiedDate = JsonConverters.fromJson(json['ModifiedDate'],'DateTime',context!);
ModifiedBy = json['ModifiedBy'];
TimeZone = json['TimeZone'];
LeaderLocked = json['LeaderLocked'];
LastSubmittedBusinessDate = JsonConverters.fromJson(json['LastSubmittedBusinessDate'],'DateTime',context!);
GracePeriodDate = JsonConverters.fromJson(json['GracePeriodDate'],'DateTime',context!);
Vested = json['Vested'];
DirectPay = JsonConverters.fromJson(json['DirectPay'],'DateTime',context!);
DirectPayApprBy = json['DirectPayApprBy'];
FactFinderBilling = JsonConverters.toDouble(json['FactFinderBilling']);
FullName = json['FullName'];
ByLastName = json['ByLastName'];
IsSecurityLicensed = json['IsSecurityLicensed'];
IsEncompassAdmin = json['IsEncompassAdmin'];
ApiKey = json['ApiKey'];
LastSessionId = json['LastSessionId'];
LastLogin = JsonConverters.fromJson(json['LastLogin'],'DateTime',context!);
MfaActive = json['MfaActive'];
RequireMFA = json['RequireMFA'];
SMSPhoneNumber = json['SMSPhoneNumber'];
VerifiedEmailStatus = json['VerifiedEmailStatus'];
VerifiedCellPhoneStatus = json['VerifiedCellPhoneStatus'];
SchedulerUrl = json['SchedulerUrl'];
QueueDefaults = JsonConverters.fromJson(json['QueueDefaults'],'QueueDefault',context!);
Roles = JsonConverters.fromJson(json['Roles'],'List<String>',context!);
PasswordUpdated = json['PasswordUpdated'];
RestrictToSingleSession = json['RestrictToSingleSession'];
return this;
}
Map<String, dynamic> toJson() => {
'AgentId': AgentId,
'Company': Company,
'AgentName': AgentName,
'FirstName': FirstName,
'LastName': LastName,
'MiddleInitial': MiddleInitial,
'Address1': Address1,
'Address2': Address2,
'City': City,
'State': State,
'Zip': Zip,
'Country': Country,
'Email': Email,
'EmailSignature': EmailSignature,
'HomePhone': HomePhone,
'CellPhone': CellPhone,
'WorkPhone': WorkPhone,
'InsLicensed': InsLicensed,
'AgreeToDisclosures': AgreeToDisclosures,
'AgreeToDate': JsonConverters.toJson(AgreeToDate,'DateTime',context!),
'PaidDate': JsonConverters.toJson(PaidDate,'DateTime',context!),
'AgentNumber': AgentNumber,
'ReferringAgent': ReferringAgent,
'PlacementAgent': PlacementAgent,
'CreatedDate': JsonConverters.toJson(CreatedDate,'DateTime',context!),
'UserId': UserId,
'IsAgent': IsAgent,
'Package': Package,
'StoreName': StoreName,
'Notes': Notes,
'Upline1': Upline1,
'Upline2': Upline2,
'Upline3': Upline3,
'Upline4': Upline4,
'MVPID': MVPID,
'AVPID': AVPID,
'RVPID': RVPID,
'AgentLevel': AgentLevel,
'IsMVP': IsMVP,
'IsRVP': IsRVP,
'IsAVP': IsAVP,
'IsAdmin': IsAdmin,
'IsBusinessCardAdmin': IsBusinessCardAdmin,
'TeamName': TeamName,
'LocationId': LocationId,
'CalendarId': CalendarId,
'Rank': Rank,
'NBC': NBC,
'Upline1Percent': Upline1Percent,
'Upline2Percent': Upline2Percent,
'Upline3Percent': Upline3Percent,
'Upline4Percent': Upline4Percent,
'AgentStatus': AgentStatus,
'Office': Office,
'DOB': JsonConverters.toJson(DOB,'DateTime',context!),
'SSN': SSN,
'Fax': Fax,
'BusinessEmail': BusinessEmail,
'ModifiedDate': JsonConverters.toJson(ModifiedDate,'DateTime',context!),
'ModifiedBy': ModifiedBy,
'TimeZone': TimeZone,
'LeaderLocked': LeaderLocked,
'LastSubmittedBusinessDate': JsonConverters.toJson(LastSubmittedBusinessDate,'DateTime',context!),
'GracePeriodDate': JsonConverters.toJson(GracePeriodDate,'DateTime',context!),
'Vested': Vested,
'DirectPay': JsonConverters.toJson(DirectPay,'DateTime',context!),
'DirectPayApprBy': DirectPayApprBy,
'FactFinderBilling': FactFinderBilling,
'FullName': FullName,
'ByLastName': ByLastName,
'IsSecurityLicensed': IsSecurityLicensed,
'IsEncompassAdmin': IsEncompassAdmin,
'ApiKey': ApiKey,
'LastSessionId': LastSessionId,
'LastLogin': JsonConverters.toJson(LastLogin,'DateTime',context!),
'MfaActive': MfaActive,
'RequireMFA': RequireMFA,
'SMSPhoneNumber': SMSPhoneNumber,
'VerifiedEmailStatus': VerifiedEmailStatus,
'VerifiedCellPhoneStatus': VerifiedCellPhoneStatus,
'SchedulerUrl': SchedulerUrl,
'QueueDefaults': JsonConverters.toJson(QueueDefaults,'QueueDefault',context!),
'Roles': JsonConverters.toJson(Roles,'List<String>',context!),
'PasswordUpdated': PasswordUpdated,
'RestrictToSingleSession': RestrictToSingleSession
};
getTypeName() => "Agent";
TypeContext? context = _ctx;
}
class AgentDistrictIdResponse implements IConvertible
{
ResponseStatus? ResponseStatus;
List<Agent>? Agents = [];
AgentDistrictIdResponse({this.ResponseStatus,this.Agents});
AgentDistrictIdResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
Agents = JsonConverters.fromJson(json['Agents'],'List<Agent>',context!);
return this;
}
Map<String, dynamic> toJson() => {
'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!),
'Agents': JsonConverters.toJson(Agents,'List<Agent>',context!)
};
getTypeName() => "AgentDistrictIdResponse";
TypeContext? context = _ctx;
}
class AgentDistrictIdRequest implements IConvertible
{
int? DistrictId;
AgentDistrictIdRequest({this.DistrictId});
AgentDistrictIdRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
DistrictId = json['DistrictId'];
return this;
}
Map<String, dynamic> toJson() => {
'DistrictId': DistrictId
};
getTypeName() => "AgentDistrictIdRequest";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'api.dev.dynamics.trendsic.com', types: <String, TypeInfo> {
'QueueDefault': TypeInfo(TypeOf.Class, create:() => QueueDefault()),
'Agent': TypeInfo(TypeOf.Class, create:() => Agent()),
'AgentDistrictIdResponse': TypeInfo(TypeOf.Class, create:() => AgentDistrictIdResponse()),
'List<Agent>': TypeInfo(TypeOf.Class, create:() => <Agent>[]),
'AgentDistrictIdRequest': TypeInfo(TypeOf.Class, create:() => AgentDistrictIdRequest()),
});
Dart AgentDistrictIdRequest 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/DistrictAgents/{DistrictId} HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<AgentDistrictIdResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Agents>
<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>
</Agents>
<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>
</AgentDistrictIdResponse>