AbodeONE

<back to all web services

DeleteFuturePlanResponse

Requires Authentication
Required role:Admin
The following routes are available for this service:
All Verbs/future_plan_response/delete
DeleteFuturePlanResponse Parameters:
NameParameterData TypeRequiredDescription
FuturePlanResponseIdqueryintNo
FuturePlanResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformFuturePlanResponseDTONo
ResponseStatusformResponseStatusNo
FuturePlanResponseDTO Parameters:
NameParameterData TypeRequiredDescription
FuturePlanResponseIdformintNo
CreatedByformstringNo
CreatedDtformDateTime?No
ExpectedCheckoutDtformDateTime?No
ExpectsCheckoutformboolNo
ForwardAddress1formstringNo
ForwardAddress2formstringNo
ForwardAddressTypeformstringNo
ForwardCityformstringNo
ForwardCountryformstringNo
ForwardEmailformstringNo
ForwardPhoneformstringNo
ForwardPostalformstringNo
ForwardStateformstringNo
FuturePlanSurveyIdformint?No
FutureTermIdformint?No
HolidayLeaveResponseIdformint?No
HousingChangeRequestsformstringNo
IsLateCheckoutformboolNo
LateCheckoutReasonformstringNo
ModifiedByformstringNo
ModifiedDtformDateTime?No
NotesformstringNo
PlanCategoryformstringNo
PlanCodeformstringNo
PlanDetailformstringNo
PlannedStayInRoomformboolNo
PlannedSummerResidentformboolNo
PlanTextformstringNo
ResidentIdformintNo
ResponseTypeformstringNo
StudentIdformintNo
SubmittedDtformDateTime?No
SummerDetailsformstringNo
SummerEndDtformDateTime?No
SummerReasonformstringNo
SummerStartDtformDateTime?No
SchoolidformstringNo
FirstNameformstringNo
LastNameformstringNo
GenderformstringNo
TermNameformstringNo
BuildingNameformstringNo
WingNameformstringNo
RoomformstringNo
EmailformstringNo
HomePhoneformstringNo
CellPhoneformstringNo
RoomPhoneformstringNo
BirthdayformDateTime?No
MailboxNameformstringNo

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

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

{
	result: 
	{
		futurePlanResponseId: 0,
		createdBy: String,
		createdDt: 0001-01-01,
		expectedCheckoutDt: 0001-01-01,
		expectsCheckout: False,
		forwardAddress1: String,
		forwardAddress2: String,
		forwardAddressType: String,
		forwardCity: String,
		forwardCountry: String,
		forwardEmail: String,
		forwardPhone: String,
		forwardPostal: String,
		forwardState: String,
		futurePlanSurveyId: 0,
		futureTermId: 0,
		holidayLeaveResponseId: 0,
		housingChangeRequests: String,
		isLateCheckout: False,
		lateCheckoutReason: String,
		modifiedBy: String,
		modifiedDt: 0001-01-01,
		notes: String,
		planCategory: String,
		planCode: String,
		planDetail: String,
		plannedStayInRoom: False,
		plannedSummerResident: False,
		planText: String,
		residentId: 0,
		responseType: String,
		studentId: 0,
		submittedDt: 0001-01-01,
		summerDetails: String,
		summerEndDt: 0001-01-01,
		summerReason: String,
		summerStartDt: 0001-01-01,
		schoolid: String,
		firstName: String,
		lastName: String,
		gender: String,
		termName: String,
		buildingName: String,
		wingName: String,
		room: String,
		email: String,
		homePhone: String,
		cellPhone: String,
		roomPhone: String,
		birthday: 0001-01-01,
		mailboxName: String
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}