AbodeONE

<back to all web services

FindFuturePlanSurveys

Requires Authentication
Required role:Admin
The following routes are available for this service:
All Verbs/future_plan_surveys
FuturePlanSurveysResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformList<FuturePlanSurveyDTO>No
ResponseStatusformResponseStatusNo
FuturePlanSurveyDTO Parameters:
NameParameterData TypeRequiredDescription
FuturePlanSurveyIdformintNo
HolidayLeaveIdformint?No
TermIdformint?No
SurveyTypeformstringNo
NameformstringNo
OpenDtformDateTime?No
CloseDtformDateTime?No
EarliestCheckoutDtformDateTime?No
LatestCheckoutDtformDateTime?No
StatementTextformstringNo
CompletionTextformstringNo
ReservationPeriodIdformint?No
RequireAppNextformboolNo

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

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

{
	result: 
	[
		{
			futurePlanSurveyId: 0,
			holidayLeaveId: 0,
			termId: 0,
			surveyType: String,
			name: String,
			openDt: 0001-01-01,
			closeDt: 0001-01-01,
			earliestCheckoutDt: 0001-01-01,
			latestCheckoutDt: 0001-01-01,
			statementText: String,
			completionText: String,
			reservationPeriodId: 0,
			requireAppNext: False
		}
	],
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}