| GET,OPTIONS | /v1/Agent/Admin |
|---|
import Foundation
import ServiceStack
public class AgentAdminRequest : Codable
{
required public init(){}
}
public class AgentResponse : Codable
{
public var responseStatus:ResponseStatus
public var agent:[Agent] = []
required public init(){}
}
public class Agent : Codable
{
public var agentId:Int
public var company:String
public var agentName:String
public var firstName:String
public var lastName:String
public var middleInitial:String
public var address1:String
public var address2:String
public var city:String
public var state:String
public var zip:String
public var country:String
public var email:String
public var emailSignature:String
public var homePhone:String
public var cellPhone:String
public var workPhone:String
public var insLicensed:Bool
public var agreeToDisclosures:Bool
public var agreeToDate:Date?
public var paidDate:Date?
public var agentNumber:String
public var referringAgent:String
public var placementAgent:String
public var createdDate:Date?
public var userId:String
public var isAgent:Bool
public var package:String
public var storeName:String
public var notes:String
public var upline1:Int?
public var upline2:Int?
public var upline3:Int?
public var upline4:Int?
public var mvpid:Int?
public var avpid:Int?
public var rvpid:Int?
public var agentLevel:Double?
public var isMVP:Bool
public var isRVP:Bool
public var isAVP:Bool
public var isAdmin:Bool
public var isBusinessCardAdmin:Bool
public var teamName:String
public var locationId:String
public var calendarId:String
public var rank:String
public var nbc:Bool
public var upline1Percent:Double?
public var upline2Percent:Double?
public var upline3Percent:Double?
public var upline4Percent:Double?
public var agentStatus:String
public var office:String
public var dob:Date?
public var ssn:String
public var fax:String
public var businessEmail:String
public var modifiedDate:Date?
public var modifiedBy:String
public var timeZone:String
public var leaderLocked:Bool
public var lastSubmittedBusinessDate:Date
public var gracePeriodDate:Date
public var vested:Bool
public var directPay:Date
public var directPayApprBy:String
public var factFinderBilling:Double?
public var fullName:String
public var byLastName:String
public var isSecurityLicensed:Bool
public var isEncompassAdmin:Bool
public var apiKey:String
public var lastSessionId:String
public var lastLogin:Date?
public var mfaActive:Bool
public var requireMFA:Bool
public var smsPhoneNumber:String
public var verifiedEmailStatus:Bool
public var verifiedCellPhoneStatus:Bool
public var schedulerUrl:String
public var queueDefaults:QueueDefault
public var roles:[String] = []
public var passwordUpdated:Bool
public var restrictToSingleSession:Bool
required public init(){}
}
public class QueueDefault : Codable
{
public var locationId:String
public var services:[String] = []
required public init(){}
}
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/Agent/Admin HTTP/1.1 Host: api.dev.dynamics.trendsic.com Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<AgentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Agent>
<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>
</Agent>
<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>
</AgentResponse>