Call structure

Call structure

A secure API connection, using the HTTPS protocol, is available at the following URL:

https://bridge.resrequest.com/api/

Please note that access to the secure API needs to be set up explicitly on request.

Warning
We are deprecating and will soon be abandoning HTTP access to our API in favour of a more secure HTTPS access. This means that as of January 2019 all connections to the ResRequest ResConnect API will require HTTPS as HTTP will no longer be supported, i.e. change your calls from http://bridge.resrequest.com/api/ to https://bridge.resrequest.com/api/.

Calls may be made using either XML-RPC (from version 7.3.30) or JSON-RPC. The content-type of the request is used to distinguish between the two encodings. A content-type of “text/xml” may be used for XML-RPC and “application/json” for JSON-RPC otherwise it is assumed JSON-RPC is being used.

Authentication

We have introduced a new method of authentication to take advantage of the new Bridge Multi-user functionality, but the old method will still be supported. Either can be used for standard calls.

Old method

The first two parameters of all API calls are a username and password. If authentication fails the call is terminated and an error returned. The third parameter is always the “id” of the principal against which the query is being processed, except in the case of “ac_get_principal.”All parameters are of type “string” unless otherwise specified.

Sequence number	Name	O/R	Usage
1	Username	Required	Username for authentication.
2	Password	Required	Password for authentication.
3	Principal	Required	“Id” of the principal to return properties for. Case sensitive.
4	Rest of parameters	As required	The rest of the parameters would follow here, as needed.

Example:

{
	"method": "ac_get_accomm",
	"params": [
		"username",
		"password", 
                "1",
		"WB10"
	],
	"id":1
}

In some circumstances you may need to connect directly to an offline server, rather than via the bridge URL above. In these cases, the first and second parameter of the API call should contain the username and password third parameter (principal “id”) is dropped altogether and the remainder of the function call remains the same.

New method

The first parameter of all API calls is a structure containing authentication information. If authentication fails the call is terminated and an error returned.

Key	O/R	Usage
bridge_username	Required	Username allocated to access the bridge.
bridge_password	Required	Password allocate to access the bridge.
link_id	Optional*	The Id of a link as returned by br_get_link. If this is used the principal_* keys must not be included.
principal_id	Optional*	The Id of the principal to link to.
principal_username	Optional*	The username to be used when accessing the chosen principal.
principal_password	Optional*	The password to be used when accessing the chosen principal.

* Not needed for bridge specific calls such as br_get_link.

Sequence number	Name	O/R	Usage
1	Auth	Required	Authentication structure.
2	Rest of parameters	Optional	The rest of the parameters would follow here, as needed.

Example:

{
	"method":"ac_get_accomm",
	"params":[
		{
			"bridge_username":"username",
			"bridge_password":"password",
			"link_id":"1"
		},
		"WB10"
	],
	"id":1
}

All API calls are logged to an audit trail for security purposes.

Multiple calls in a single request.

In addition to supporting basic single calls, we also support an extension to the standard called “system.multicall”. This extension is documented at http://mirrors.talideon.com/articles/multicall.html

Warning
We currently only support JSON-RPC v1 with the “system.multicall” extension and do not support JSON-RPC v2 batch calls. These two standards have a different format and are not interchangeable.

Call structure

Warning

Authentication

Multiple calls in a single request.

Warning

Keep up to date with us

Menu

Visit our website

ResRequest Modules