Show / Hide Table of Contents

    Enum MessageParameterLocation

    Defines the request message parameter location.

    Namespace: Nevatech.Vsb.Repository.Entities
    Assembly: Nevatech.Vsb.Repository.dll
    Syntax
    public enum MessageParameterLocation

    Fields

    Name Description
    Body

    The payload that's appended to the HTTP request. Since there can only be one payload, there can only be one body parameter. The name of the body parameter has no effect on the parameter itself and is used for documentation purposes only. Since Form parameters are also in the payload, body and form parameters cannot exist together for the same operation.

    Cookie

    Custom HTTP cookies that are expected as part of the request.

    Form

    Used to describe the payload of an HTTP request when either application/x-www-form-urlencoded, multipart/form-data or both are used as the content type of the request (in Swagger's definition, the consumes property of an operation). This is the only parameter type that can be used to send files, thus supporting the file type. Since form parameters are sent in the payload, they cannot be declared together with a body parameter for the same operation. Form parameters have a different format based on the content-type used.

    Header

    Custom HTTP headers that are expected as part of the request.

    Path

    Used together with Path Templating, where the parameter value is a part of the operation's URL. This does not include the host or base path of the API. For example, in /items/{itemId}, the path parameter is itemId.

    Query

    Parameter is appended to the URL. For example, in /items?id=###, the query parameter is id.

    Back to top Nevatech Sentinet 6.5 Online Documentation