regis

<back to all web services

FinanceBalanceRequest

Requires Authentication
Required permission:ReadAccountBalance
The following routes are available for this service:
POST/Finance/Balance/{uuid}
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using regis.ClassLibrary.Requests;
using regis.ClassLibrary.Responses;

namespace regis.ClassLibrary.Requests
{
    public partial class FinanceBalanceRequest
    {
        public virtual string uuid { get; set; }
    }

}

namespace regis.ClassLibrary.Responses
{
    public partial class FinanceBalanceResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual int regent_id { get; set; }
        public virtual string first_name { get; set; }
        public virtual string last_name { get; set; }
        public virtual string email { get; set; }
        public virtual string current_program { get; set; }
        public virtual string first_regent_term { get; set; }
        public virtual DateTime? first_registered_date { get; set; }
        public virtual DateTime? last_registered_date { get; set; }
        public virtual string uuid { get; set; }
        public virtual decimal total_payments { get; set; }
        public virtual decimal total_charges { get; set; }
        public virtual decimal balance { get; set; }
        public virtual decimal gp_raw_balance { get; set; }
        public virtual bool is_vendor { get; set; }
        public virtual bool is_customer { get; set; }
    }

}

C# FinanceBalanceRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + 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
}