| 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 .jsv suffix or ?format=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-staging.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
}
}
}