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

{"planCategory":"String","includeInactive":false}
HTTP/1.1 200 OK
Content-Type: application/json
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"}}}