regis

FinanceBalanceRequest

**Requires Authentication**
Required permission:	ReadAccountBalance

The following routes are available for this service:
POST	/Finance/Balance/{uuid}

"use strict";
export class FinanceBalanceResponse {
    /** @param {{responseStatus?:ResponseStatus,regent_id?:number,first_name?:string,last_name?:string,email?:string,current_program?:string,first_regent_term?:string,first_registered_date?:string,last_registered_date?:string,uuid?:string,total_payments?:number,total_charges?:number,balance?:number,gp_raw_balance?:number,is_vendor?:boolean,is_customer?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {number} */
    regent_id;
    /** @type {string} */
    first_name;
    /** @type {string} */
    last_name;
    /** @type {string} */
    email;
    /** @type {string} */
    current_program;
    /** @type {string} */
    first_regent_term;
    /** @type {?string} */
    first_registered_date;
    /** @type {?string} */
    last_registered_date;
    /** @type {string} */
    uuid;
    /** @type {number} */
    total_payments;
    /** @type {number} */
    total_charges;
    /** @type {number} */
    balance;
    /** @type {number} */
    gp_raw_balance;
    /** @type {boolean} */
    is_vendor;
    /** @type {boolean} */
    is_customer;
}
export class FinanceBalanceRequest {
    /** @param {{uuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    uuid;
}

JavaScript FinanceBalanceRequest DTOs

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

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<FinanceBalanceRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Requests">
  <uuid>String</uuid>
</FinanceBalanceRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FinanceBalanceResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/regis.ClassLibrary.Responses">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <balance>0</balance>
  <current_program>String</current_program>
  <email>String</email>
  <first_name>String</first_name>
  <first_regent_term>String</first_regent_term>
  <first_registered_date>0001-01-01T00:00:00</first_registered_date>
  <gp_raw_balance>0</gp_raw_balance>
  <is_customer>false</is_customer>
  <is_vendor>false</is_vendor>
  <last_name>String</last_name>
  <last_registered_date>0001-01-01T00:00:00</last_registered_date>
  <regent_id>0</regent_id>
  <total_charges>0</total_charges>
  <total_payments>0</total_payments>
  <uuid>String</uuid>
</FinanceBalanceResponse>