AbodeONE

<back to all web services

CreateFuturePlanResponse

Requires Authentication
Required role:Admin
The following routes are available for this service:
All Verbs/future_plan_response/create
CreateFuturePlanResponse Parameters:
NameParameterData TypeRequiredDescription
StudentIdqueryintNo
ResidentIdqueryintNo
FuturePlanSurveyIdqueryintNo
FutureTermIdqueryintNo
HolidayLeaveResponseIdqueryint?No
ResponseTypequerystringNo
PlanCategoryquerystringNo
PlanCodequerystringNo
ExpectsCheckoutquerybool?No
PlanTextquerystringNo
PlanDetailquerystringNo
HousingChangeRequestsquerystringNo
PlannedStayInRoomquerybool?No
PlannedSummerResidentquerybool?No
SummerStartDtqueryDateTime?No
SummerEndDtqueryDateTime?No
SummerReasonquerystringNo
SummerDetailsquerystringNo
NotesquerystringNo
ExpectedCheckoutDtqueryDateTime?No
ForwardAddressTypequerystringNo
ForwardAddress1querystringNo
ForwardAddress2querystringNo
ForwardCityquerystringNo
ForwardStatequerystringNo
ForwardPostalquerystringNo
ForwardCountryquerystringNo
ForwardPhonequerystringNo
ForwardEmailquerystringNo
SubmittedDtqueryDateTime?No
IsLateCheckoutquerybool?No
LateCheckoutReasonquerystringNo
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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST //future_plan_response/create HTTP/1.1 
Host: api.lsu.abodehms.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"studentId":0,"residentId":0,"futurePlanSurveyId":0,"futureTermId":0,"holidayLeaveResponseId":0,"responseType":"String","planCategory":"String","planCode":"String","expectsCheckout":false,"planText":"String","planDetail":"String","housingChangeRequests":"String","plannedStayInRoom":false,"plannedSummerResident":false,"summerStartDt":"0001-01-01T00:00:00.0000000","summerEndDt":"0001-01-01T00:00:00.0000000","summerReason":"String","summerDetails":"String","notes":"String","expectedCheckoutDt":"0001-01-01T00:00:00.0000000","forwardAddressType":"String","forwardAddress1":"String","forwardAddress2":"String","forwardCity":"String","forwardState":"String","forwardPostal":"String","forwardCountry":"String","forwardPhone":"String","forwardEmail":"String","submittedDt":"0001-01-01T00:00:00.0000000","isLateCheckout":false,"lateCheckoutReason":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"result":{"futurePlanResponseId":0,"createdBy":"String","createdDt":"0001-01-01T00:00:00.0000000","expectedCheckoutDt":"0001-01-01T00:00:00.0000000","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-01T00:00:00.0000000","notes":"String","planCategory":"String","planCode":"String","planDetail":"String","plannedStayInRoom":false,"plannedSummerResident":false,"planText":"String","residentId":0,"responseType":"String","studentId":0,"submittedDt":"0001-01-01T00:00:00.0000000","summerDetails":"String","summerEndDt":"0001-01-01T00:00:00.0000000","summerReason":"String","summerStartDt":"0001-01-01T00:00:00.0000000","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-01T00:00:00.0000000","mailboxName":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}