Macro to execute a webservice request and embed the result in a page.
Note that this macro will by default return an XmlReader object as result.
Note that this macro will by default return an XmlReader object as result.
Syntax
Smartsite SXML | Copy Code |
---|---|
<se:webservice /> |
Parameters
Name | Data Type | Properties | Description |
---|---|---|---|
BindingConfigurationName | String |
Trim
|
Sets the name of the binding configuration. When you specify aBindingConfigurationName, the web.config must contain a binding configuration section with that name. |
BindingType | Enum |
Trim
|
Sets the type of the binding.
Enum values:
|
EndpointConfigurationName | String |
Trim
|
Sets the name of the endpoint configuration. When you specify anEndpointConfigurationName, the web.config must contain an (client) endpoint configuration with that name. |
Format | String |
RawData
|
Sets the formatting Xml. |
LiteralMethodNode | String |
RawData
|
Literal body element, which will be appended to the method-node of the SoapEnvelope. Use either this property or the MethodArguments property to specify the method arguments/parameters. (When both properties are specified, LiteralMethodeNode will be ignored.) |
MaxReceivedMessageSize | Integer | - |
Sets the max received message size. IfBindingConfigurationNamehas been specified as well, MaxReceivedMessageSize will be ignored. |
MaxRows | Integer | - | Sets a limit for the number of rows that the output may contain. |
MethodArguments | Collection | - | The method arguments. |
MethodName | String |
Trim
|
The name of the webservice method that should be invoked.
It is required to either specify the MethodName or the LiteralMethodNode parameter. |
MethodNamespace | String |
Trim
|
The namespace to be used on the MethodName. |
MethodNamespacePrefix | String |
Trim
|
The namespace to be used on the MethodNamespace. |
OutputInnerText | Boolean | - | If true, the "innerText" of the SoapEnvelope response will be returned as result. If false, the result should be formatted using the format-parameter. |
OutputRequestEnvelope | Boolean | - |
Outputs the request SoapEnvelope as string (debug option). The actual request will not be executed, so there will be no response. |
ParametersNamespace | String |
Trim
|
The namespace to be used for the parameters/arguments inside the body element. |
Password | String | - |
Sets the password. Only needed when the webservice is restricted by means of basic http authentication. |
RawSoapHeaders | String |
Trim
|
Sets the raw (literal) SOAP headers. |
ReadSchema | Boolean | - | Sets a value indicating whether to use the option XmlReadMode.ReadSchema when reading the response into a DataSet. This setting is only applicable when resulttype has been set to DataTable. |
RowDelimiter | String | - | Specifies the delimiter string that separates individual records. |
RowFormat | String |
RawData
|
Sets the formatting string. |
SendTimeout | Integer | - |
Sets the send timeout (in seconds). When you need to set one of the other timeout values, use a binding configuration section and specify its name using the parameter BindingConfigurationName. |
SkipRows | Integer | - | Specifies which row will be the first row in the output. |
SoapAction | String |
Trim
|
The SoapAction HTTP header. When not specified, it defaults to MethodNamespace + MethodName. |
Url | Locator |
Trim
|
The url of the webservice. |
UserName | String | - |
Sets the name of the user. Only needed when the webservice is restricted by means of basic http authentication. |
WriteTypeAttributes | Boolean | - | Determines if type-information (e.g. xsi:type= 'xsd:int') should be included on the argument(s). Defaults to true. |
Shared Parameters
Local Viper Methods
Viper | Extension | Description |
---|---|---|
This.ChildLevelResult | Gets the result of the child levels. | |
This.ClearForcedResult |
Sets the result of the macro. used to override the normal handling of the result creation. |
|
This.ColCount | Gets the number of columns in the datatable. | |
This.ColName | Gets the name of the current column. | |
This.ColNumber | Gets the number of the current column. | |
This.Field | Gets the field value of the current column in the current row, when using colformat. | |
This.Field.Exists | Checks whether the given field exists. | |
This.GetForcedResult | Gets the forced result of the macro, set by overriding the normal rendering using SetForcedResult(). | |
This.Group | Gets the name of the current group. | |
This.GroupCount | Gets the total number of groups displayed. | |
This.GroupNumber | Gets the number of the current group. | |
This.GroupResult | Gets the result of the current group. | |
This.GroupRowNumber | Gets the number of the current row in the current group. | |
This.Level | Gets the current formatting level. | |
This.LevelResult | Gets the result of the current level. | |
This.LevelRowNumber | Gets the current row of the current level. | |
This.Location | Gets the location the current row points to, in a macro that can build URLs. | |
This.MaxRows | Gets a limit for the number of rows that the output may contain. | |
This.Name | Gets the title or name represented by the current row. | |
This.param | Gets the value of a parameter with the given index. Useful when using the viper:exec inside xslt formatting. | |
This.RawField | Gets the raw field value of the current column in the current row, when using colformat. | |
This.RenderTime | ✓ | Returns the render time of the macro in milliseconds. |
This.RowCount | Gets the total number of rows in the datatable. | |
This.RowNumber | Gets the current row number. | |
This.RowResult | Gets the result of the current row. | |
This.SetForcedResult |
Sets the result of the macro. used to override the normal handling of the result creation. |
|
This.SkipRows | Specifies which row will be the first row in the output. | |
This.Title | Gets the title represented by the current row. | |
This.VisibleRowCount | Gets the total number of rows displayed. | |
This.VisibleRowNumber | Gets the current visible row number. |