Vertec Python module “vtcweb”

http_method

Contains the HTTP method used to call the Web service. Possible values are GET, POST, PUT, and DELETE.

path_parameters

Contains the list of path parameters of the URL after the method name.

Calling http://<host>/api/webservice/<webservicename>/<method-name>/additional/path/parameters for example:

self.path_parameters=("additional", "path", "parameters")

headers

A dictionary containing the headers of the WebRequest in the form "Header-Name": "Header-Value". The header Authorization is not returned. For duplicate headers, only the first value is returned.

query

A dictionary containing the query parameters of the WebRequest in the form "Query-Name": "Query-Value". The apiToken parameter is not returned. For duplicate query parameters, only the first value is returned.

querystring

body

parse_request_body ([expected_attributes=None])

If the request is JSON or HTML (content-type application/json or x-www-form-urlencoded), this method can deserialize the request body and write the values as attributes to a helper object where they can be retrieved directly.

For JSON, the type of the values is the same as the type. For HTML, all values are returned as a string.

{
  "abbreviation": "AD",  
  "level": 5270,    
}

result = self.parse_request_body()
result.abbreviation = "AD" # string
result.level = 5270 # int

Keys that are not valid Python identifiers are ignored and a corresponding message is logged.

expected_attributes

The optional expected_attributes parameter can be used to validate and process the request body. This only works with JSON bodies.

As expected_attributes, a dictionary is passed whose keys are the expected attributes in the body and whose values are their type.

 expected_attributes = {
    "abbreviation": "str",
    "level": "int"
    }

Possible types are:

• str
• int
• float
• bool
• datetime
• array(typ): If a list is expected, array can specify one of the other types as the object type, for example array(int) for a list of integers.

When calling parse_request_body(expected_attributes) it is ensured that all specified attributes are present and can be converted to the specified type. Otherwise the WebRequest is answered with Statuscode 400 Bad Request and a corresponding message.

The values do not necessarily have to be of the specified type, they just have to be convertable to that type. For example, the string "5270" could be returned as “level” because it can be converted to an integer. Date values must be returned according to Iso standard 8601 in order to be identified and converted.

The returned object then contains all attributes converted to the expected type.

Attributes not included in expected_attributes are processed as described above.

response

A response object that is automatically used to respond to the WebRequest if the method itself does not have a return value. The following values can be set to it:

• status_code: status code (integer) of the web response, e.g. 200 for OK.
• body: The body of the web response, <empty> by default.
• headers: A dictionary of response headers.

as_json(content): response

This method serializes the passed content as a JSON string and returns a Response object with the following parameters:

• status_code = 200
• body = Content as JSON string. If the content passed is already a string, it is assumed that it is a valid JSON string, which is written directly to the body.
• headers[“Content-Type”] = "application/json"

log(log_object)

Writes the passed object to the log. Can handle strings, but also other objects.

The object is written to the Vertec session log using the category Webservices and the log level Debug / 10 (see also Debug Categories). To see these entries in the log file, you need to include parameter DebugCategories=Vertec.Webservices under [Log] in the Vertec.ini configuration file.

In addition, the object is also written to the output with print. You will see this output in the Web service entry in the Access log field if the Track requests option is activated.

return <Integer>

An integer is interpreted as a status code. The response contains no other values.

return “String”

return self.response

return self.as_json(content)