Web script description language XML reference and description of advanced
This section of the documentation describes the web script description language.
The webscript element in a web descriptor file provides the root XML element. The webscript element is required.
The shortname element in a web descriptor file provides a human readable name for the web script. The shortname element is required.
The description element in a web descriptor file provides documentation for the web script. The description element is optional.
The url element represents a URI template to which the web script is bound. Variants of the URI template which specify a format do not need to be registered, however, specifying them is useful for documentation purposes. There must be at least one url element, but there can be several.
The format element controls how the content-type of the response can be specified by using the URI. The format element is optional.
The authentication element specifies the level of authentication required to run the web script. The authentication element is optional.
The transaction element specifies the transaction level required to run the web script. The transaction element is optional.
The family element allows a web script developer to categorize their web scripts. Any value can be assigned to family and any number of families can be assigned to the web script, providing a freeform tagging mechanism. The web script index provides views for navigating web scripts by family. The family tag can be repeated if the script belongs to multiple families. The family element is optional.
The cache element specifies the required caching level. The cache element is optional.
The negotiate element associates an Accept header MIME type to a specific web script format of response. The mandatory value specifies the format while the mandatory attribute, accept, specifies the MIME type. Content Negotiation is enabled with the definition of at least on negotiate element. The negotiate element can be specified zero or more times.
The lifecycle element allows a web script developer to indicate the development status of a web script. Typically, web scripts start out in a draft state while being developed or tested, are promoted to production quality for widespread use, and finally retired at the end of their life. The lifecycle element is optional.