Hide Comments

The parameter element defines a parameter that may be passed as part of a Request (header or query) or Response (header only).

Syntax

[required] param <parameter-name> ( ([~of] type <data-type>) | ([~bound [~to]] <property-name>) ) [[~located] in (header | query)]

Examples

Request

// roleCode in the header will be treated like an integer

required param roleCode of type int located in header

// roleName in the header will be treated like a string

required param roleName of type string located in header

// searchNameLike in the query will be treated like a string

param searchNameLike of type string located in query

// id in the query will be bound to the taxpayerID of the Data Structure bound to the parent resource

param id bound to property taxpayerID

Response

// roleCode in the header will be treated like an integer

required param roleCode of type int in header

// roleName in the header will be treated like a string

required param roleName of type string in header

Parameters

Name

Type

Description

required

keyword

Indicates that this parameter MUST be specified in a valid request.

<parameter-name>

Name

The name assigned to this parameter.

<data-type>

SName(Built-in Primitive Type)

The data type of the parameter.  MUST be one of the built-in types specified in Built-in Primitive Data Types.

<property-name>

SName(Primitive Property)

The name of a Primitive Property defined in the Data Structure to which the containing message is bound.   This property binding indicates that the Message Parameter is used as an identifier, filter, or other data-bound operator, associated directly with the bound property.  It also implies that the parameter value SHOULD match the data type of the bound property.

header

keyword

Indicates that the parameter is passed in the header of the request or response message.

 

For response message parameters, header is the default location, and the only allowable parameter location.  However, the header keyword MAY still be included for clarity in response parameters.

query

keyword

Indicates that the parameter is passed in the query string of the request.  Only request message parameters MAY use the query keyword.

 

For request message parameters, query is the default location.  However, the query keyword MAY still be included for clarity in request parameters.

Child Elements

None

Parent Elements

Request
Response

Created with Help & Manual 6 and styled with Premium Pack Version 2.51 © by EC Software