PARAM

path

SSI

N

No

no

Parameter associated with a variable cited via an @Path annotation.

Example:

/car/{idcar}/{idcolor}

The number of occurrences is equal to the number found of {variable} in the URI.

Example:

PARAM idcar,I[path] idcolor,I[path]

query

SSI or

SSI_1D

N

Yes

yes

Parameter associated with a parameter of a URL.

Example:

/car?id=10&color=blue

The number of occurrences is equal to the number found of parameter variables in the URL.

Example:

/car?id=10&color=blue

PARAM id,I[query:required] color,I[query:optional('red')]

It is possible to have several parameter variables with the same name and therefore to retrieve a collection of values.

The parameter declared must then be a table of dimension 1.

Example:

/car?color=blue&color=green&color=red

ALPHA(32) color(5)

PARAM color,I[query:required],color

For a parameter with the ParamName internal name not defining an external name, the parameter name to write in the URL's parameter string must be: pmPARAMNAME.

Example:

NUM_BIN_4 id

ALPHA(32) color

PARAM id,I[query:required] color,I[query:optional('red')]

URL : /car?pmID=10&pmCOLOR=red

header

SSI

or

SSI_1D

N

Yes

Yes

Parameter associated with an HTTP header.

The number of occurrences is equal to the number of headers to be retrieved.

It is possible to have several header fields with the same name and therefore to retrieve a collection of values. The parameter declared must then be a table of dimension 1.

Example:

ALPHA(256) hdrCT

PARAM hdrCT,I[header('Content-Type'):required]

form

SSI

N

Yes

No

Parameter associated with an HTTP form field.

Example:

ALPHA(256) CliName

PARAM CliName,I[form('name'):required]

cookie

SSI

N

Yes

No

Parameter associated with a cookie.

The number of occurrences is equal to the number of cookies to be retrieved.

Example:

ALPHA(256) infCookCli

PARAM infCookcli,I[cookie('cook_inf_lastcli'):required]

content

SwCLS

1

No

No

Parameter associated with the content (body) of the HTTP query. The format of this content is one of those defined via the @Consumes annotation.

The content can be retrieved in a simple type or an Adelia class.

multipart

SwCLS

N

Yes

No

Parameter associated with part of the contents of the HTTP query in the case of a message consisting of several data sets grouped together in one body; the format of this content is named multipart.

Each identified part of the content may be associated with a parameter; a mime type (Content-Type) can be specified for each of the parts.

Example:

REF_CLASS(COMPUTER) iComputer

REF_CLASS(PRINTER) iPrinter

PARAM iComputer,I[multipart('id1'):type('application/xml'):required] iPrinter,I[multipart('id2'):type('application/json'):optional]

Notes:

• for the consumed format, you must choose one of the existing multipart mime types, i.e:
  • multipart/form-data
  • multipart/mixed
  • multipart/alternative
  • multipart/related
    Example:
    WS_CONFIGURE *OPERATION '@Consumes' 'multipart/form-data'
• In the case of an optional parameter, a default value can only be specified for the ALPHA, DATE , TIME and TIMESTAMP types.
  Example:
  

  DATE iDate

  PARAM iDate,I[multipart('id1'):optional(19980712)]

attachment

ALPHA or

ALPHA(n) or

LIST

1

No

Yes

Parameter associated with one or more files to be retrieved (upload).

The parameter is then either of the ALPHA type, or a one-dimensional ALPHA table, or a list of an ALPHA zone.

The parameter contains the name(s) and location(s) of the file(s) uploaded.

The target directory for storing attached file is by default the directory defined by the environment variable java.temp of the JVM.

The VaToolBxWSSetAttachmentDirectory function is used to change this location and must be called before the call of the service procedure, i.e. in the INIT_PGM block of the program, which is declared beforehand as a service initialisation block: WS_CONFIGURE *SERVICE '_init_pgm_as_method' 'false

Example:

WS_CONFIGURE *OPERATION '@Consumes' 'multipart/form-data'

ALPHA(256) FileName

LIST LstAttachedFiles FileName

PARAM LstAttachedFiles,I[attachment]
...

[DECL_PGM]
WS_CONFIGURE *SERVICE '_init_pgm_as_method' 'false'
[INIT_PGM]

CALL_CLASS 'VaToolBx' 'VaToolBxWSSetAttachmentDirectory" 'c:\temp\files'

header

SSI

or

SSI_1D

N

Yes

Parameter associated with an HTTP header.

The number of occurrences is equal to the number of header fields to be sent.

Example:

ALPHA(256) hdrLocation

PARAM hdrLocation,O[header('Content-Location')]

If the parameter is a one-dimensional array, then each value in the array is passed in the form of a header of the same name.

Example:

ALPHA(32) hdrValues(2)

hdrValues(1)=value1

hdrValues(2)=value2

PARAM hdrValues,O[header('headerName)]

→ headerName : value1, value2

cookie

SSI

N

No

content

SwCLS

N

No

Parameter associated with the content (body) of the HTTP answer. The format of this content is one of those defined via the @Produces annotation.

The content to be sent can be based on all of the following Adelia types (simple types, one-dimensional arrays, LIST, REF_CLASS).

It is possible to declare several output parameters of the content type; these are then aggregated into a structure that can be named with the order:

WS-CONFIGURE *OPERATION '_root_result_name' 'StrucureName'

multipart

SwCLS

N

No

Parameter associated with part of the contents of the HTTP answer for a message consisting of several data sets grouped together in one body; the format of this content is named multipart.
Each identified part of the content may be associated with a parameter;

a mime type (Content-Type) may be specified for each of the parts.

Example:

REF_CLASS(COMPUTER) iComputer

REF_CLASS(PRINTER) iPrinter

PARAM iComputer,O[multipart('part1'):type('application/xml')] iPrinter,I[multipart('part2'):type('application/json')] ]

Note: for the produced format you must choose one of the existing multipart mime types, namely:

• multipart/form-data

• multipart/mixed

• multipart/alternative

• multipart/related

Example:

WS_CONFIGURE *OPERATION '@Produces' 'multipart/form-data'

attachment

ALPHA or
ALPHA(n) or
LIST

1

Yes

Parameter associated with one or more files to be sent (download).

The parameter is then either of the ALPHA type, or a one-dimensional ALPHA table, or a list of an ALPHA zone.

The parameter contains the name(s) and location(s) of the file(s) to be downloaded.

Example:

ALPHA(256) FileNames(2)

BOOL cRet

PARAM FileNames,O[attachment]

/* Downloading files pic1.jpg and pic2.jpg located in the directory

/* '/images' of the web application.

CALL_CLASS 'VaToolBx' 'VaToolBxAwsGetRealPath' '/images/pic1.jpg' FileNames(1) cRet

CALL_CLASS 'VaToolBx' 'VaToolBxAwsGetRealPath' '/images/pic2.jpg' FileNames(2) cRet

HTTPstatus

NUM_BIN_4

1

No

Parameter associated with the HTTP status code returned by the service.

The httpStatus type parameter is not compulsory; it replaces the code calculated by default and which, in some cases, makes it possible to define a more appropriate return code.

Example:

NUM_BIN_4     httpstatus

PARAM httpstatus,o[httpstatus]

if ok_read

  httpstatus = 200 /* the code HTTP 200 is returned: OK

else

  httpstatus = 404 /* the code HTTP 404 is returned: not found

end