AbodeONE

<back to all web services

FindCharges

Requires Authentication
Required role:Admin
The following routes are available for this service:
GET/students/{StudentId}/charges
GET/charges
GET/disciplines/{DisciplineId}/charges
FindCharges Parameters:
NameParameterData TypeRequiredDescription
TermIdqueryint?No
StudentIdpathint?No
DisciplineIdpathint?No
FindChargesResponse Parameters:
NameParameterData TypeRequiredDescription
ResultsformIEnumerable<ChargeDTO>No
ResponseStatusformResponseStatusNo
ChargeDTO Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
ChargeTypeIdformintNo
StudentIdformintNo
AmountformdecimalNo
ChargeDateformDateTimeNo
DescriptionformstringNo
BuildingIdformintNo
CheckedByformstringNo
DisciplineIdformint?No
CashPaidformdecimal?No
CashPaidDateformDateTime?No
AccountPaidformdecimal?No
SubmittedDateformDateTime?No
AppliedDateformDateTime?No
Tracked Parameters:
NameParameterData TypeRequiredDescription
CreatedDtformDateTimeNo
CreatedByformstringNo
ModifiedDtformDateTime?No
ModifiedByformstringNo

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.

GET //students/{StudentId}/charges HTTP/1.1 
Host: api.lsu.abodehms.com 
Accept: text/jsv
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
		}
	}
}