REST Call Schema Definitions

REST Call Schema describes the standard MATRIXX REST call schema.

Table 1. REST Call Schema

Parameter	Description
name	The name of the REST call.
description	A description of what the call does.
class	An arbitrary name for a class of REST calls which is used to group related calls together.
url	The URL that the REST call handles.
method	One of the following: GET POST PUT DELETE
<mapping>readData</mapping>	Causes the REST call to read any post data sent with the request into the input object.
<mapping>attachVersion 1</mapping>	Sets the SubMan version to 1 (which is the only supported version).
<mapping>buildSubscriberSearch SearchTerm</mapping>	Fills a subscriber search block using the SearchTerm parameter.
<patch>route = setRoute(route, SearchTerm)</patch>	Handles TRA routing information.
<callout_statement>...</callout_statement>	When a REST call includes a <callout_statment> node, it signals to the code generator that this is a custom REST call. This turns off generation of code that sends the input message to the engine and processes the response from the engine into a Result. Instead, these lines become the "work" that the REST call performs. In the purchase sample, an instance of a class called DemoServices is constructed and then the sample calls into the queryAndPurchase method of that class.
<url_param>...</url_param>	Describes a parameter that is part of the URL to this call.
<request_param>...</request_param>	Defines an HTTP post parameter that can be passed by the client when the REST call is performed.
<metadata>...</metadata>	Defines some metadata about this REST call. In the purchase example, the standard OUTPUT filter is defined for this call to be the empty filter "{}". The filter can include and exclude information.