Required permission: | ReadAccountBalance |
POST | /Finance/Balance/{uuid} |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
uuid | path | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No | |
regent_id | form | int | No | |
first_name | form | string | No | |
last_name | form | string | No | |
form | string | No | ||
current_program | form | string | No | |
first_regent_term | form | string | No | |
first_registered_date | form | DateTime? | No | |
last_registered_date | form | DateTime? | No | |
uuid | form | string | No | |
total_payments | form | decimal | No | |
total_charges | form | decimal | No | |
balance | form | decimal | No | |
gp_raw_balance | form | decimal | No | |
is_vendor | form | bool | No | |
is_customer | form | bool | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /Finance/Balance/{uuid} HTTP/1.1
Host: data.regent-college.edu
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
uuid: String
}
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, meta: { String: String } } ], meta: { String: String } }, regent_id: 0, first_name: String, last_name: String, email: String, current_program: String, first_regent_term: String, first_registered_date: 0001-01-01, last_registered_date: 0001-01-01, uuid: String, total_payments: 0, total_charges: 0, balance: 0, gp_raw_balance: 0, is_vendor: False, is_customer: False }