REST.Types.TRESTRequestParameterOption

• Up to Parent: REST.Types

Delphi

TRESTRequestParameterOption = (
poDoNotEncode,
poTransient,
poAutoCreated,
poFlatArray,
poPHPArray,
poListArray,
poSqids
);

C++

enum DECLSPEC_DENUM TRESTRequestParameterOption : unsigned char { poDoNotEncode, poTransient, poAutoCreated, poFlatArray, poPHPArray, poListArray, poSqids };

Properties

Type	Visibility	Source	Unit	Parent
enum	public	REST.Types.pas REST.Types.hpp	REST.Types	REST.Types

Description

Controls the way of the request parameters utilization.

This enumeration defines the following values:

• poDoNotEncode: Indicates that the value of this parameter should be used as it is and it cannot be encoded by the component.
• poTransient: Indicates that the transient parameter is typically created and managed by attached components, such as an authenticator at runtime.
• poAutoCreated: Indicates that a parameter was created by a component while parsing the base-URL or a resource.
• poFlatArray: Indicates that the ';' separated the list of values of this parameter and it should be expanded into name=val1&...&=valN.
• poPHPArray: Indicates that the ';' separated the list of values of this parameter and it should be expanded into name[]=val1&...&[]=valN.
• poListArray: Indicates that the ';' separated the list of values of this parameter and it should be expanded into name=val1,...,valN.

Note: The poFlatArray, poPHPArray, and poListArray values have effect only for query parameters. They control how "val1;...;valN" values will be expanded into a query string.