AbodeONE

<back to all web services

CreateCharge

Requires Authentication
Required role:Admin
The following routes are available for this service:
POST/charges
CreateCharge Parameters:
NameParameterData TypeRequiredDescription
ChargeTypeIdbodyintNo
StudentIdbodyintNo
AmountbodydecimalNo
ChargeDatebodyDateTimeNo
DescriptionbodystringNo
BuildingIdbodyintNo
CheckedBybodystringNo
DisciplineIdbodyint?No
CashPaidbodydecimal?No
CashPaidDatebodyDateTime?No
AccountPaidbodydecimal?No
SubmittedDatebodyDateTime?No
AppliedDatebodyDateTime?No
CreateChargeResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformChargeDTONo
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.

POST //charges HTTP/1.1 
Host: api.lsu.abodehms.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	chargeTypeId: 0,
	studentId: 0,
	amount: 0,
	chargeDate: 0001-01-01,
	description: String,
	buildingId: 0,
	checkedBy: String,
	disciplineId: 0,
	cashPaid: 0,
	cashPaidDate: 0001-01-01,
	accountPaid: 0,
	submittedDate: 0001-01-01,
	appliedDate: 0001-01-01
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	result: 
	{
		id: 0,
		chargeTypeId: 0,
		studentId: 0,
		amount: 0,
		chargeDate: 0001-01-01,
		description: String,
		buildingId: 0,
		checkedBy: String,
		disciplineId: 0,
		cashPaid: 0,
		cashPaidDate: 0001-01-01,
		accountPaid: 0,
		submittedDate: 0001-01-01,
		appliedDate: 0001-01-01,
		createdDt: 0001-01-01,
		createdBy: String,
		modifiedDt: 0001-01-01,
		modifiedBy: String
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}