AbodeONE

FindFuturePlanOptions

**Requires Authentication**
Required role:	Admin

The following routes are available for this service:
All Verbs	/future_plan_options

**FindFuturePlanOptions** Parameters:
Name	Parameter	Data Type	Required	Description
PlanCategory	query	string	No
IncludeInactive	query	bool	No

**FuturePlanOptionsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Result	form	List<FuturePlanOptionDTO>	No
ResponseStatus	form	ResponseStatus	No

**FuturePlanOptionDTO** Parameters:
Name	Parameter	Data Type	Required
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 .xml suffix or ?format=xml

HTTP + XML

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/xml
Content-Type: application/xml
Content-Length: length

<FindFuturePlanOptions xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AbodeAPI.ServiceModel">
  <IncludeInactive>false</IncludeInactive>
  <PlanCategory>String</PlanCategory>
</FindFuturePlanOptions>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FuturePlanOptionsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AbodeAPI.ServiceModel">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Result>
    <FuturePlanOptionDTO>
      <DisplayOrder>0</DisplayOrder>
      <ExpectsCheckout>false</ExpectsCheckout>
      <FuturePlanOptionId>0</FuturePlanOptionId>
      <IsActive>false</IsActive>
      <PlanCategory>String</PlanCategory>
      <PlanCode>String</PlanCode>
      <PlanFeedback>String</PlanFeedback>
      <PlanText>String</PlanText>
      <PromptForDetail>false</PromptForDetail>
    </FuturePlanOptionDTO>
  </Result>
</FuturePlanOptionsResponse>