The following are sample HTTP requests and responses.
The placeholders shown need to be replaced with actual values.
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String
}
]
},
VerifiedBusiness: False,
ContestEntered: False,
AgentDetails:
{
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-01,
PaidDate: 0001-01-01,
AgentNumber: String,
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,
BusinessEmail: 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,
Title: String,
Website: String,
TextingReminderOptOut: False
},
ContactDetails:
{
ContactId: 0,
ContactType: 0,
FirstName: String,
LastName: String,
Title: String,
EmailWork: String,
EmailPersonal: String,
State: String,
Phone: String,
LastContact: 0001-01-01,
DoNotContact: False,
AgentId: 0,
PhoneAlt: String,
PeraContactId: 0,
SourceTypeId: 0,
SourceTypeDesc: String,
SourceNote: String,
ContactStatusId: 0,
ContactStatusDesc: String,
SSN: String,
DateOfBirth: 0001-01-01,
Deleted: False,
IsShared: False,
address_line1: String,
address_city: String,
address_state: String,
address_zip: String,
DeletedBy: String,
DeletedDateTimeUtc: 0001-01-01,
HasNBC: False,
HasFactFinderSheet: False,
MiddleInitial: String,
Tags: String,
DateCreated: 0001-01-01,
PhoneLabel: String,
AltPhoneLabel: String,
Carriers: String,
ContactImage: String,
AdditionalInformation: String,
HasGiftCard: False,
MaritalStatus: String,
ContactGUID: 00000000000000000000000000000000,
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
}
],
Employee:
{
Id: 0,
ContactId: 0,
EmployerId: 0,
SchoolId: 0,
EmployerName: String,
SchoolName: String,
FullSSN: String,
Gender: String,
EmployeeId: String,
DateOfHire: 0001-01-01,
DateOfTermination: 0001-01-01,
Compensation: 0,
HoursWorked: 0,
LocationId: String,
RoleId: 0,
IsMarried: False,
LastSentToIPXDate: 0001-01-01,
UserId: 00000000000000000000000000000000,
DateOfRehire: 0001-01-01,
EmployeeStatus: String,
InternetAgreementSignedDate: 0001-01-01,
IPXSponsorUserId: String,
PeraConnectAgentId: 0
},
Employer:
{
Id: 0,
ContactId: 0,
NCESId: String,
Name: String,
StateId: 0,
Street: String,
City: String,
Zip: String,
EmployeeCount: 0,
SchoolSiteCount: 0,
BankName: String,
BankAddress: String,
BankCity: String,
BankState: String,
BankZip: String,
RoutingNumber: String,
AccountNumber: String,
PayrollTriggerDate: 0001-01-01,
AccountType: String,
EIN: String,
PartnerId: 0,
PartnerFirstName: String,
PartnerLastName: String
},
School:
{
Id: 0,
ContactId: 0,
EmployerId: 0,
Name: String,
SchoolLevelId: 0,
City: String,
County: String,
Zip: String,
Zip4: String,
Phone: String,
Website: String,
Street1: String,
Street2: String,
EmployeeCount: 0,
SchoolSiteCount: 0,
BankName: String,
BankAddress: String,
BankCity: String,
BankState: String,
BankZip: String,
RoutingNumber: String,
AccountNumber: String,
PayrollTriggerDate: 0001-01-01,
PayrollFrequency: String,
PayrollTrigger: String,
LocationId: String,
Employer:
{
Id: 0,
ContactId: 0,
NCESId: String,
Name: String,
StateId: 0,
Street: String,
City: String,
Zip: String,
EmployeeCount: 0,
SchoolSiteCount: 0,
BankName: String,
BankAddress: String,
BankCity: String,
BankState: String,
BankZip: String,
RoutingNumber: String,
AccountNumber: String,
PayrollTriggerDate: 0001-01-01,
AccountType: String,
EIN: String,
PartnerId: 0,
PartnerFirstName: String,
PartnerLastName: String
}
},
Vendor:
{
Id: 0,
ContactId: 0,
Name: String,
Website: String,
Fax: String,
IPXVendorId: String,
SPARKFileSharingFrequency: String,
SPARKFileSharingFrequencyOther: String,
SPARKContactName: String,
SPARKContactPhone: String,
SPARKContactEmail: String,
BankName: String,
BankAddress: String,
BankCity: String,
BankState: String,
BankZip: String,
RoutingNumber: String,
AccountNumber: String,
DataTransmissionMethod: String
},
Partner:
{
Id: 0,
ContactId: 0,
EIN: String,
EmployerCount: 0,
FullSSN: String
},
CRMImage: String
}
}