regis

<back to all web services

FinanceBalanceRequest

Requires Authentication
Required permission:ReadAccountBalance
The following routes are available for this service:
POST/Finance/Balance/{uuid}
import Foundation
import ServiceStack

public class FinanceBalanceRequest : Codable
{
    public var uuid:String

    required public init(){}
}

public class FinanceBalanceResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var regent_id:Int
    public var first_name:String
    public var last_name:String
    public var email:String
    public var current_program:String
    public var first_regent_term:String
    public var first_registered_date:Date?
    public var last_registered_date:Date?
    public var uuid:String
    public var total_payments:Double
    public var total_charges:Double
    public var balance:Double
    public var gp_raw_balance:Double
    public var is_vendor:Bool
    public var is_customer:Bool

    required public init(){}
}


Swift FinanceBalanceRequest DTOs

To override the Content-type in your clients, use the 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 /Finance/Balance/{uuid} HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"uuid":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
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-01T00:00:00.0000000","last_registered_date":"0001-01-01T00:00:00.0000000","uuid":"String","total_payments":0,"total_charges":0,"balance":0,"gp_raw_balance":0,"is_vendor":false,"is_customer":false}