AbodeONE

<back to all web services

GetSelfMoveIn

Requires Authentication
The following routes are available for this service:
GET/student/{StudentId}/self_move_in
GET/reservation/{ReservationId}/self_move_in
GET/self_move_in
GetSelfMoveIn Parameters:
NameParameterData TypeRequiredDescription
StudentIdpathint?No
SchoolIdquerystringNo
TermIdqueryint?No
ReservationIdpathint?No
SelfMoveInResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformSelfMoveInDTONo
SelfMoveInStepsformList<string>No
ResponseStatusformResponseStatusNo
SelfMoveInDTO Parameters:
NameParameterData TypeRequiredDescription
StudentIdformintNo
TermIdformintNo
ReservationIdformintNo
AllowSelfMoveInformboolNo
SelfMoveInStateformSelfMoveInStateEnumNo
SelfMoveInDtformDateTime?No
BillingStartOptionformBillingStartOptionEnumNo
BillingEndOptionformBillingEndOptionEnumNo
FirstNameformstringNo
LastNameformstringNo
DisplayNameformstringNo
SchoolidformstringNo
ReservedBuildingformstringNo
ReservedRoomformstringNo
ReservedRoomRateformstringNo
MovedInBuildingformstringNo
MovedInRoomformstringNo
MovedInRoomRateformstringNo
SelfMoveInStateEnum Enum:
Contact
Inspection
MoveIn
Complete
Disabled
BillingStartOptionEnum Enum:
Auto
Term
MoveIn
BillingEndOptionEnum Enum:
Auto
Term
MoveOut

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

{
	result: 
	{
		studentId: 0,
		termId: 0,
		reservationId: 0,
		allowSelfMoveIn: False,
		selfMoveInState: Contact,
		selfMoveInDt: 0001-01-01,
		billingStartOption: Auto,
		billingEndOption: Auto,
		firstName: String,
		lastName: String,
		displayName: String,
		schoolid: String,
		reservedBuilding: String,
		reservedRoom: String,
		reservedRoomRate: String,
		movedInBuilding: String,
		movedInRoom: String,
		movedInRoomRate: String
	},
	selfMoveInSteps: 
	[
		String
	],
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}