| Required role: | Admin |
| All Verbs | /future_plan_responses |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| BuildingIds | query | ArrayOfInt | No | |
| TermId | query | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Result | form | List<FuturePlanResponseDTO> | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| FuturePlanResponseId | form | int | No | |
| CreatedBy | form | string | No | |
| CreatedDt | form | DateTime? | No | |
| ExpectedCheckoutDt | form | DateTime? | No | |
| ExpectsCheckout | form | bool | No | |
| ForwardAddress1 | form | string | No | |
| ForwardAddress2 | form | string | No | |
| ForwardAddressType | form | string | No | |
| ForwardCity | form | string | No | |
| ForwardCountry | form | string | No | |
| ForwardEmail | form | string | No | |
| ForwardPhone | form | string | No | |
| ForwardPostal | form | string | No | |
| ForwardState | form | string | No | |
| FuturePlanSurveyId | form | int? | No | |
| FutureTermId | form | int? | No | |
| HolidayLeaveResponseId | form | int? | No | |
| HousingChangeRequests | form | string | No | |
| IsLateCheckout | form | bool | No | |
| LateCheckoutReason | form | string | No | |
| ModifiedBy | form | string | No | |
| ModifiedDt | form | DateTime? | No | |
| Notes | form | string | No | |
| PlanCategory | form | string | No | |
| PlanCode | form | string | No | |
| PlanDetail | form | string | No | |
| PlannedStayInRoom | form | bool | No | |
| PlannedSummerResident | form | bool | No | |
| PlanText | form | string | No | |
| ResidentId | form | int | No | |
| ResponseType | form | string | No | |
| StudentId | form | int | No | |
| SubmittedDt | form | DateTime? | No | |
| SummerDetails | form | string | No | |
| SummerEndDt | form | DateTime? | No | |
| SummerReason | form | string | No | |
| SummerStartDt | form | DateTime? | No | |
| Schoolid | form | string | No | |
| FirstName | form | string | No | |
| LastName | form | string | No | |
| Gender | form | string | No | |
| TermName | form | string | No | |
| BuildingName | form | string | No | |
| WingName | form | string | No | |
| Room | form | string | No | |
| form | string | No | ||
| HomePhone | form | string | No | |
| CellPhone | form | string | No | |
| RoomPhone | form | string | No | |
| Birthday | form | DateTime? | No | |
| MailboxName | form | string | No |
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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST //future_plan_responses HTTP/1.1
Host: api.lsu.abodehms.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"buildingIds":[0],"termId":0}
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"}}}