AbodeONE

<back to all web services

FindFuturePlanOptions

Requires Authentication
Required role:Admin
The following routes are available for this service:
All Verbs/future_plan_options
FindFuturePlanOptions Parameters:
NameParameterData TypeRequiredDescription
PlanCategoryquerystringNo
IncludeInactivequeryboolNo
FuturePlanOptionsResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformList<FuturePlanOptionDTO>No
ResponseStatusformResponseStatusNo
FuturePlanOptionDTO Parameters:
NameParameterData TypeRequiredDescription
FuturePlanOptionIdformintNo
PlanCodeformstringNo
PlanTextformstringNo
PlanFeedbackformstringNo
PlanCategoryformstringNo
ExpectsCheckoutformboolNo
PromptForDetailformboolNo
DisplayOrderformintNo
IsActiveformboolNo

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

{
	planCategory: String,
	includeInactive: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	result: 
	[
		{
			futurePlanOptionId: 0,
			planCode: String,
			planText: String,
			planFeedback: String,
			planCategory: String,
			expectsCheckout: False,
			promptForDetail: False,
			displayOrder: 0,
			isActive: False
		}
	],
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}