AbodeONE

<back to all web services

GetHousingPoolMember

Requires Authentication
Required role:Admin
The following routes are available for this service:
GET/housing_pool_members/{Id}
GetHousingPoolMember Parameters:
NameParameterData TypeRequiredDescription
IdpathintNo
GetHousingPoolMemberResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformHousingPoolMemberDTONo
ResponseStatusformResponseStatusNo
HousingPoolMemberDTO Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
HousingPoolIdformintNo
StudentIdformintNo
AppIdformint?No
CopiedFromHousingPoolIdformint?No
FuturePlanResponseIdformint?No
MemberStatusformHousingPoolMemberStatus?No
MemberStatusDtformDateTime?No
MemberStatusUsernameformstringNo
ArrivalDtformDateTimeNo
RequestAssignedRoommateformbool?No
IsRaformbool?No
FeeTypeformHousingPoolMemberFeeType?No
FeeAmountformintNo
FeeStatusformHousingPoolMemberFeeStatus?No
FeeStatusDtformDateTime?No
FeeUsernameformstringNo
RoomAloneStatusformHousingPoolMemberRoomAloneStatus?No
RoomAloneStatusDtformDateTime?No
RoomAloneUsernameformstringNo
PriorityScoreformint?No
PriorityRankformint?No
CommentsformstringNo
ApprovalDtformDateTime?No
ApprovalReasonformstringNo
ApprovalUserformstringNo
CreatedDtformDateTimeNo
CreatedByformstringNo
ModifiedDtformDateTime?No
ModifiedByformstringNo
HousingPoolMemberStatus Enum:
Active
Waitlist
Denied
Requested
Canceled
HousingPoolMemberFeeType Enum:
Deposit
Onetime
Annual
Session
None
HousingPoolMemberFeeStatus Enum:
Paid
Refunded
Unknown
Unpaid
HousingPoolMemberRoomAloneStatus Enum:
NotRequested
Requested
Denied
Approved

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

{
	result: 
	{
		id: 0,
		housingPoolId: 0,
		studentId: 0,
		appId: 0,
		copiedFromHousingPoolId: 0,
		futurePlanResponseId: 0,
		memberStatus: Active,
		memberStatusDt: 0001-01-01,
		memberStatusUsername: String,
		arrivalDt: 0001-01-01,
		requestAssignedRoommate: False,
		isRa: False,
		feeType: Deposit,
		feeAmount: 0,
		feeStatus: Paid,
		feeStatusDt: 0001-01-01,
		feeUsername: String,
		roomAloneStatus: NotRequested,
		roomAloneStatusDt: 0001-01-01,
		roomAloneUsername: String,
		priorityScore: 0,
		priorityRank: 0,
		comments: String,
		approvalDt: 0001-01-01,
		approvalReason: String,
		approvalUser: String,
		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
		}
	}
}