regis

<back to all web services

FinanceBalanceRequest

Requires Authentication
Required permission:ReadAccountBalance
The following routes are available for this service:
POST/Finance/Balance/{uuid}
namespace regis.ClassLibrary.Requests

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type FinanceBalanceResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val regent_id:Int32 = new Int32() with get,set
        member val first_name:String = null with get,set
        member val last_name:String = null with get,set
        member val email:String = null with get,set
        member val current_program:String = null with get,set
        member val first_regent_term:String = null with get,set
        member val first_registered_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val last_registered_date:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val uuid:String = null with get,set
        member val total_payments:Decimal = new Decimal() with get,set
        member val total_charges:Decimal = new Decimal() with get,set
        member val balance:Decimal = new Decimal() with get,set
        member val gp_raw_balance:Decimal = new Decimal() with get,set
        member val is_vendor:Boolean = new Boolean() with get,set
        member val is_customer:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type FinanceBalanceRequest() = 
        member val uuid:String = null with get,set

F# 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}