REST.Types.TRESTRequestParameterKind

From Appmethod Libraries
Jump to: navigation, search

Object Pascal

TRESTRequestParameterKind = (
pkCOOKIE,
pkGETorPOST,
pkURLSEGMENT,
pkHTTPHEADER,
pkREQUESTBODY
);

C++

enum DECLSPEC_DENUM TRESTRequestParameterKind : unsigned char { pkCOOKIE, pkGETorPOST, pkURLSEGMENT, pkHTTPHEADER, pkREQUESTBODY };

Properties

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

Description

Specifies the types of parameters that can be added to requests.

This enumeration defines the following values:

  • pkCOOKIE: Parameter is put into a cookie.
  • pkGETorPOST: Parameter will be sent as a URL parameter (for GET requests) or as a body parameter (for POST/PUT requests).
  • pkURLSEGMENT: Parameter will be used as value for a URL segment. A URL segment can be defined in a request's resource path: customer/{ID}. If a URL Segment parameter with a name of "ID", then its value will be replaced for {ID} in the example above.
  • pkHTTPHEADER: Parameter is put in the request's HTTP header.
  • pkREQUESTBODY: The parameter value will be used as a request body. If more than one parameter of this kind exists, the request will use a multi-part body.