| Required role: | Admin |
| All Verbs | /future_plan_options |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PlanCategory | query | string | No | |
| IncludeInactive | query | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Result | form | List<FuturePlanOptionDTO> | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| FuturePlanOptionId | form | int | No | |
| PlanCode | form | string | No | |
| PlanText | form | string | No | |
| PlanFeedback | form | string | No | |
| PlanCategory | form | string | No | |
| ExpectsCheckout | form | bool | No | |
| PromptForDetail | form | bool | No | |
| DisplayOrder | form | int | No | |
| IsActive | form | bool | 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_options HTTP/1.1
Host: api.lsu-staging.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"}}}