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 java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class FinanceBalanceRequest
    {
        public String uuid = null;
        
        public String getUuid() { return uuid; }
        public FinanceBalanceRequest setUuid(String value) { this.uuid = value; return this; }
    }

    public static class FinanceBalanceResponse
    {
        public ResponseStatus responseStatus = null;
        public Integer regent_id = null;
        public String first_name = null;
        public String last_name = null;
        public String email = null;
        public String current_program = null;
        public String first_regent_term = null;
        public Date first_registered_date = null;
        public Date last_registered_date = null;
        public String uuid = null;
        public BigDecimal total_payments = null;
        public BigDecimal total_charges = null;
        public BigDecimal balance = null;
        public BigDecimal gp_raw_balance = null;
        public Boolean is_vendor = null;
        public Boolean is_customer = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public FinanceBalanceResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
        public Integer getRegentId() { return regent_id; }
        public FinanceBalanceResponse setRegentId(Integer value) { this.regent_id = value; return this; }
        public String getFirstName() { return first_name; }
        public FinanceBalanceResponse setFirstName(String value) { this.first_name = value; return this; }
        public String getLastName() { return last_name; }
        public FinanceBalanceResponse setLastName(String value) { this.last_name = value; return this; }
        public String getEmail() { return email; }
        public FinanceBalanceResponse setEmail(String value) { this.email = value; return this; }
        public String getCurrentProgram() { return current_program; }
        public FinanceBalanceResponse setCurrentProgram(String value) { this.current_program = value; return this; }
        public String getFirstRegentTerm() { return first_regent_term; }
        public FinanceBalanceResponse setFirstRegentTerm(String value) { this.first_regent_term = value; return this; }
        public Date getFirstRegisteredDate() { return first_registered_date; }
        public FinanceBalanceResponse setFirstRegisteredDate(Date value) { this.first_registered_date = value; return this; }
        public Date getLastRegisteredDate() { return last_registered_date; }
        public FinanceBalanceResponse setLastRegisteredDate(Date value) { this.last_registered_date = value; return this; }
        public String getUuid() { return uuid; }
        public FinanceBalanceResponse setUuid(String value) { this.uuid = value; return this; }
        public BigDecimal getTotalPayments() { return total_payments; }
        public FinanceBalanceResponse setTotalPayments(BigDecimal value) { this.total_payments = value; return this; }
        public BigDecimal getTotalCharges() { return total_charges; }
        public FinanceBalanceResponse setTotalCharges(BigDecimal value) { this.total_charges = value; return this; }
        public BigDecimal getBalance() { return balance; }
        public FinanceBalanceResponse setBalance(BigDecimal value) { this.balance = value; return this; }
        public BigDecimal getGpRawBalance() { return gp_raw_balance; }
        public FinanceBalanceResponse setGpRawBalance(BigDecimal value) { this.gp_raw_balance = value; return this; }
        public Boolean getIsVendor() { return is_vendor; }
        public FinanceBalanceResponse setIsVendor(Boolean value) { this.is_vendor = value; return this; }
        public Boolean getIsCustomer() { return is_customer; }
        public FinanceBalanceResponse setIsCustomer(Boolean value) { this.is_customer = value; return this; }
    }

}

Java 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>