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
}
]
},
RootAgentId: 0,
Agents:
[
{
AgentId: 0,
FirstName: String,
LastName: String,
AgentNumber: String,
AgentStatus: String,
Rank: String,
ParentAgentId: 0,
ParentName: String,
Depth: 0,
TreePath: String,
MasterAccount: 0,
PersonId: 0,
IsRoot: False
}
],
Earnings:
[
{
AgentId: 0,
BatchId: 0,
Advance: 0,
AsEarned: 0,
Backend: 0,
OverrideBonus: 0,
Residual: 0,
SurvivalBonus: 0,
OtherBonus: 0,
Clawback: 0,
BackendClawback: 0,
BackendClawbackForgiven: 0,
Other: 0,
PositiveTotal: 0,
NegativeTotal: 0,
ListingsNet: 0,
DownlineOverrideAmount: 0,
PersonalProductionAmount: 0,
AdjustmentCredit: 0,
AdjustmentDebit: 0,
AdjustmentLead: 0,
AdjustmentNet: 0,
NetEarnings: 0,
ListingCount: 0,
PayoutPolicyCount: 0,
ClawbackPolicyCount: 0
}
],
Batches:
[
{
BatchId: 0,
CommissionStartDate: 0001-01-01,
CommissionEndDate: 0001-01-01,
PaymentDate: 0001-01-01,
Label: String,
IsUnbatched: False
}
]
}