AbodeONE

<back to all web services

GetHousingAssignment

Requires Authentication
The following routes are available for this service:
All Verbs/housing_assignment/{Id}
GetHousingAssignment Parameters:
NameParameterData TypeRequiredDescription
IdpathintNo
HousingAssignmentResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformHousingAssignmentDTONo
ResponseStatusformResponseStatusNo
HousingAssignmentDTO Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
PersonIdformstringNo
StartDateformstringNo
EndDateformstringNo
CurrentStatusformstringNo
CurrentStatusDateformstringNo
RoomformstringNo
BuildingformstringNo
TermIdformstringNo
RoomRateTableformstringNo
RoomRatePeriodformstringNo
OverrideRateformstringNo
OverrideRateReasonformstringNo
OverrideChargeCodeformstringNo
OverrideReceivableTypeformstringNo
OverrideRefundFormulaformstringNo
ContractformstringNo
CommentsformstringNo
ResidentStaffIndicatorformstringNo
ResidentIdformint?No
ReservationIdformint?No
StudentIdformintNo
SchoolIdformstringNo
AbodeTermIdformint?No
AbodeUsernameformstringNo

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 //housing_assignment/{Id} HTTP/1.1 
Host: api.lsu-staging.abodehms.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	id: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	result: 
	{
		id: String,
		personId: String,
		startDate: String,
		endDate: String,
		currentStatus: String,
		currentStatusDate: String,
		room: String,
		building: String,
		termId: String,
		roomRateTable: String,
		roomRatePeriod: String,
		overrideRate: String,
		overrideRateReason: String,
		overrideChargeCode: String,
		overrideReceivableType: String,
		overrideRefundFormula: String,
		contract: String,
		comments: String,
		residentStaffIndicator: String,
		residentId: 0,
		reservationId: 0,
		studentId: 0,
		schoolId: String,
		abodeTermId: 0,
		abodeUsername: String
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}