AbodeONE

<back to all web services

DeleteResident

Requires Authentication
The following routes are available for this service:
DELETE/resident/{ResidentId}
DeleteResident Parameters:
NameParameterData TypeRequiredDescription
ResidentIdpathintNo
RoomRatePeriodquerystringNo
PreserveOrphanChecksquerybool?No
OverrideWarningsquerybool?No
ResidentResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformResidentDTONo
ResponseStatusformResponseStatusNo
ResidentDTO Parameters:
NameParameterData TypeRequiredDescription
ResidentIdformintNo
StudentIdformintNo
SchoolIdformstringNo
FirstNameformstringNo
LastNameformstringNo
DisplayNameformstringNo
BedIdformintNo
MailboxformstringNo
RoomIdformintNo
RoomRateIdformint?No
RoomformstringNo
RoomCodeformstringNo
WingformstringNo
BuildingformstringNo
BuildingCodeformstringNo
MoveInDateformDateTime?No
MoveOutDateformDateTime?No
ReserveStartDtformDateTime?No
ReserveEndDtformDateTime?No
CheckInUserIdformint?No
CheckInUserformstringNo
StatusformstringNo
TermCodeformstringNo
DftBillingTypeformstringNo
BillingStartOptionformstringNo
BillingEndOptionformstringNo
IsBillableformboolNo

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.

DELETE //resident/{ResidentId} 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: 
	{
		residentId: 0,
		studentId: 0,
		schoolId: String,
		firstName: String,
		lastName: String,
		displayName: String,
		bedId: 0,
		mailbox: String,
		roomId: 0,
		roomRateId: 0,
		room: String,
		roomCode: String,
		wing: String,
		building: String,
		buildingCode: String,
		moveInDate: 0001-01-01,
		moveOutDate: 0001-01-01,
		reserveStartDt: 0001-01-01,
		reserveEndDt: 0001-01-01,
		checkInUserId: 0,
		checkInUser: String,
		status: String,
		termCode: String,
		dftBillingType: String,
		billingStartOption: String,
		billingEndOption: String,
		isBillable: False
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}