HTTP request to a remote server
- Vladimir Tayzhev
- Technical Service Specialist
These elements have the class "notifier" and the type "http request".
The following queries are used for management:
addhttprequest - create or edit an http request. Extra options are:
- k - user session ID;
- id - the notification identifierж if there is no identifier, a new notification is created, otherwise the existing one is edited;
- name - the name of the notification, the length is not more than 63 characters;
- type - type of message, required only when creating a new one, "http request";
- login - user login;
- password - the password of the user;
- to - number of the recipient;
- message - message text template, the length is not more than 1023 characters;
- newline - newline separator: "linux" for %0A coding, "win" for %0D%0A coding;
- request_type - the type of the request GET, POST, DELETE, PUT;
- server - the path to the server to which the request is addressed;
- head - the header of the message, determines the type of content;
- data - the query data.
When creating a new element, the request_type, server fields are mandatory. If a new element is successfully created, the response contains the element identifier, and looks like:
<error type="no error" id="606001" /> |
When modifying an item, only modifiable parameters can be specified. Empty parameters delete the previous value.
delhttprequest - delete the http request. Required parameters are:
- k - user session ID;
- id - element ID.
getelement - read the element. Required parameters are:
- k - user session ID;
- id - element ID.
The response contains information about the element:
<element id="605078" module="2010" num="50" clas="notifier" type="http request" name="HTTP request 1" state="normal" value="-" view="0" request_type="POST" server="http://serverworld.com/posdf/" head="Content-Type: application/json" data="{ "versionguid": "f498e8b1", "numberofsaves": "271" }"></element> |
The status field, if any, determines the server's response after the last transaction or after the last the message about the error that occurred. The fields status, login, password, to, message, head, data can be empty or absent.
testmessage - send a test http request, without creating an element. Extra options are:
- k - user session ID;
- type - the type of the message, "http request";
- login - user login;
- password - the password of the user;
- to - number of the recipient;
- message - message text template, the length is not more than 1023 characters;
- newline - newline separator: "linux" for %0A coding, "win" for %0D%0A coding;
- request_type - the type of the request GET, POST, DELETE, PUT;
- server - the path to the server to which the request is addressed;
- head - the header of the message, determines the type of content;
- data - the query data.
The response to this request contains the server answer in the field status:
<error type="no error" status="HTTP/1.1 200 OK <error type="authorization error" />" /> |