AbodeONE

<back to all web services

FindHousingExports

Requires Authentication
The following routes are available for this service:
All Verbs/housing_exports
FindHousingExports Parameters:
NameParameterData TypeRequiredDescription
StudentIdqueryint?No
TermIdqueryint?No
ReservationIdqueryint?No
ResidentIdqueryint?No
XptSauHousingIdqueryint?No
HousingExportsResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformList<XptSauHousingDTO>No
ResponseStatusformResponseStatusNo
XptSauHousingDTO Parameters:
NameParameterData TypeRequiredDescription
XptSauHousingIdformintNo
ResidentIdformint?No
ReservationIdformint?No
StudentIdformintNo
SchoolIdformstringNo
TermIdformintNo
ExtTermIdformstringNo
ExtRoomformstringNo
ExtBuildingformstringNo
ExtCurrentStatusformstringNo
ExtCurrentStatusDateformstringNo
ExtStartDateformstringNo
ExtEndDateformstringNo
ExtRoomRatePeriodformstringNo
ExtRoomRateTableformstringNo
SyncDtformDateTime?No
SyncMsgformstringNo
PriorSyncDtformDateTime?No
PriorSyncMsgformstringNo
MealPlanSyncDtformDateTime?No
MealPlanSyncMsgformstringNo
PriorMealPlanSyncDtformDateTime?No
PriorMealPlanSyncMsgformstringNo
ModifiedDtformDateTime?No
ModifiedByformstringNo
StudentNameformstringNo
TermNameformstringNo

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

{
	studentId: 0,
	termId: 0,
	reservationId: 0,
	residentId: 0,
	xptSauHousingId: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	result: 
	[
		{
			xptSauHousingId: 0,
			residentId: 0,
			reservationId: 0,
			studentId: 0,
			schoolId: String,
			termId: 0,
			extTermId: String,
			extRoom: String,
			extBuilding: String,
			extCurrentStatus: String,
			extCurrentStatusDate: String,
			extStartDate: String,
			extEndDate: String,
			extRoomRatePeriod: String,
			extRoomRateTable: String,
			syncDt: 0001-01-01,
			syncMsg: String,
			priorSyncDt: 0001-01-01,
			priorSyncMsg: String,
			mealPlanSyncDt: 0001-01-01,
			mealPlanSyncMsg: String,
			priorMealPlanSyncDt: 0001-01-01,
			priorMealPlanSyncMsg: String,
			modifiedDt: 0001-01-01,
			modifiedBy: String,
			studentName: String,
			termName: String
		}
	],
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}