Required permission: | ReadAccountBalance |
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; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>