Webservices.nl
Manual 28-11-2024
Getting Started
Implementation
Implementation
Accounting
Services
Service methods

Meta

This service provides information about all Webservices.nl webservices exposed through the RPC/SOAP API.

Summary
Meta
This service provides information about all Webservices.nl webservices exposed through the RPC/SOAP API.
Meta services
metaGetServices
Returns list with all webservices (endpoints) provided by Webservices.nl
metaGetService
Returns a list of methods/interfaces for provided webservice (Endpoint).
metaGetMethod
Returns a detailed overview about a endpoint method.
MetaServiceReference
Webservices.nl Service (Endpoint) Reference.
MetaServiceDefinition
Returns details and method references of given service.
MetaMethodReference
Returns details about the requested method.
MetaMethodDefinition
Returns all details about the requested method.
MetaElementDefinition
Defines all there is to know about an element (input or output).
MetaValidationDefinition
Validation rule for input or output element
MetaProtocolDefinition
Returns details about the requested protocol.

Meta services

metaGetServices

Returns list with all webservices (endpoints) provided by Webservices.nl

Parameters

Nothing

Returns

outA Patterns::{Type}Array of MetaServiceReference.

metaGetService

Returns a list of methods/interfaces for provided webservice (Endpoint).

Parameters

service_namename of webservice (endpoint) to fetch methods for.

Returns

outMetaServiceDefinition.

metaGetMethod

Returns a detailed overview about a endpoint method.  Name, arguments, documentation.

Parameters

service_namename of webservice (Endpoint).
method_namename of method (Interface).

Returns

outMetaMethodDefinition.

MetaServiceReference

Webservices.nl Service (Endpoint) Reference.

namename of the webservice (Endpoint).
categorytrivial category of the webservice (Endpoint).
descriptionshort description about the webservice
documentation_urlURL to the documentation on webservices.nl
statuscurrent status of webservice (online, offline).

MetaServiceDefinition

Returns details and method references of given service.

namename of the webservice (Endpoint).
categorytrivial category of the webservice (Endpoint).
descriptionshort description about the webservice
documentation_urlURL to documentation on webservices.nl
methodsA Patterns::{Type}Array of MetaMethodReference
protocolsA Patterns::{Type}Array of MetaProtocolDefinition of bindings via it can be accessed.
statuscurrent status of webservice (online, offline).

MetaMethodReference

Returns details about the requested method.

namename of the method.  (Interface).
descriptionMethod Description. description of the operation.
deprecatedis it still usable?
latestIf method is latest version.
documentation_urlhyperlink to documentation.

MetaMethodDefinition

Returns all details about the requested method.

namename of the method.  (Interface).
service_namename of the webservice (Endpoint).
deprecatedWhether this method is deprecated.
latestIf method is latest version.
descriptionMethod Description. description of the operation.
documentationShort documentation sentence.
documentation_urlurl to documentation.
input_elementsA Patterns::{Type}Array of MetaElementDefinition as input of this method.
output_elementsA Patterns::{Type}Array of MetaElementDefinition as output of this method.
related_methodsA Patterns::{Type}Array of MetaMethodReference related to this method

MetaElementDefinition

Defines all there is to know about an element (input or output).

nameName of element.
typeType of element.  For example simple types like:
numberfloat, int or int32
stringtext
booleantrue / false
descriptionDescription of element.
documentation_urlUrl to documentation [optional]
requiredIf element is required yes or no.
validationsA Patterns::{Type}Array of MetaValidationDefinition as input of this method.  [Optional]
default_valueDefault value, when present [Optional].

MetaValidationDefinition

Validation rule for input or output element

typeType of validation.  (min, max, regex)
valueValue of validation.

MetaProtocolDefinition

Returns details about the requested protocol.

documentation_urlURL to documentation.
locationURL of location.
typetype of binding.
Generated by Natural Docs
An array of type {Type} entries.
Webservices.nl Service (Endpoint) Reference.
Returns details and method references of given service.
Returns all details about the requested method.
Returns details about the requested method.
Returns details about the requested protocol.
Defines all there is to know about an element (input or output).
Validation rule for input or output element