Bombshell Agency Platform Service

<back to all web services

PeraAgentRequest

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

To override the Content-type in your clients HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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

POST /csv/reply/PeraAgentRequest HTTP/1.1 
Host: api2.exactmedicare.com 
Content-Type: text/csv
Content-Length: length

AgentId,Agent
0,"[{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,OrganizationTypeId:0,OrganizationTypeName:String,CountyName:String,StateName:String,ProductTypeId:0,AcceptInPersonMeetings:False,AcceptVirtualMeetings:False}],DistrictsWaitingList:[{Id:0,AgentId:0,DistrictId:0,Name:String,CampaignTypeId:0,DateCreated:0001-01-01,OrganizationTypeId:0,OrganizationTypeName:String,CountyName:String,StateName:String,ProductTypeId:0}],AgentProductTypes:[{AgentId:0,ProductType:{},ProductTypeId:{},DateCreated:0001-01-01}],ApiKey:00000000000000000000000000000000,VCAppts:False,FaceToFaceAppts:False}]"

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

Agent,ResponseStatus
"[{FullName:String,ByLastName:String,IsEncompassAdmin:False,PeraApiKey:00000000000000000000000000000000,IsLite:False,MVPName:String,AVPName:String,RVPName:String,Upline1Name:String,Upline2Name:String,Upline3Name:String,Upline4Name:String,StateLicense:String,Location:String,Licenses:[{Id:0,AgentId:0,ContactId:0,AgentRegistrationTempId:0,LicenseTypeId:0,SecurityLicenseTypeId:0,LicenseTypeName:String,SecuritiesLicenseTypeName:String,LicenseState:String,LicenseNumber:String,Temporary:False,DateCreated:0001-01-01,DateModified:0001-01-01,DateAcquired:0001-01-01,ExpirationDate:0001-01-01,IsResident:False}],LastLoginDate:0001-01-01,AccountType:{Id:{},Name:String,Description:String,ConversionSupported:False},Outstand:{Id:0,AgentId:0,Username:String,Initialized:False,Status:String},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,BusinessEmail:String,HomePhone:String,CellPhone:String,WorkPhone:String,InsLicensed:False,AgreeToDisclosures:False,AgreeToDate:0001-01-01,PaidDate:0001-01-01,AgentNumber:String,AccountTypeId:0,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,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,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,IsSecurityLicensed:False,ProfilePicture:String,MailingAddress1:String,MailingAddress2:String,MailingCity:String,MailingState:String,MailingZip:String,RegistrationRequirementMet:False,AgentNPN:String,LicenseType:String,EBShares:0,ABShares:0,AgentTypeId:0,StartDate:0001-01-01,PartnerID:0}]","{ErrorCode:String,Message:String,StackTrace:String,Errors:[{ErrorCode:String,FieldName:String,Message:String}]}"