User-defined methods are methods for which you fully define the processing, input, and output data in code. This type therefore offers the greatest flexibility.
For examples for the user-defined methods, see the SDK under Sdk01_Basics\03-CustomMethod.cs.
SQL methods are methods that provide data from a predefined SQL query through the API. Create the parameters of a request as SQL parameters.
For examples for the definition of SQL methods, see the SDK under Sdk01_Basics\02-BasicSqlMethod.cs.
Use WebSocket methods in situations where bidirectional, event controlled communications is required. You define the processing as well as input and output data within the WebSocket method.
NOTE: When the session ends or the server, all open WebSocket connections are also closed.
For examples of WebSocket methods, see the SDK under Sdk01_Basics\19-WebSockets.cs.
For more information about WebSocket implementation, see https://learn.microsoft.com/en-us/dotnet/api/system.net.websockets.websocket?view=net-8.0.
Responses that are sent from the REST API use the following codes. If requests fail, an explanatory error message is displayed.
200 |
Request was successful. |
204 |
Request was successful. Response has no content. |
401 |
Access not authorized. The session must be authorized first. |
403 |
Login failed. For example, this response is sent if an incorrect user name or password is entered. |
404 |
The given resource could not be found. |
405 |
The HTTP method used is not allowed for this request. |
500 |
A server error occurred. The error message is sent with the response. On the ground of security, a detailed error message is not included in the response. For more information, see the application log file on the server. |