Rezlynx API
cim_GetAccounts
This method provides a way of retrieving accounts from the Central Invoicing Module by providing various search criteria as parameters.
Parameters
Name | Type | Description |
---|---|---|
SessionID | string | Session ID |
likeAccountRef | string | Account reference |
likeAccountName | string | Account name |
likeStreet | string | Street |
likeArea | string | Area |
likeTown | string | Town |
likeCounty | string | County |
likeCountry | string | Country |
likePostcode | string | Postcode |
likeTelNo | string | Telephone number |
likeEmail | string | Email address |
limit | int | Maximum number of results returned |
likeStudentID | string | Student ID |
LinkedToCompany | string | Company reference, if linked to company |
LinkedToProfile | string | Profile reference, if linked to profile |
Returned data
- A set of CIM accounts
Returned data (CIM account)
Name | Type | Description |
---|---|---|
Reference | string | Account reference |
Name | string | Account name |
LinkedToProfileRef | string | Profile reference linked to this account |
LinkedToCompanyRef | string | Company reference linked to this account |
DefaultAddressType | "LinkedAddress" or "CustomAddress" | Address type |
Street | string | Address street name |
Area | string | Address area |
Town | string | Address town or city |
County | string | Address county or state |
Country | string | Address country |
Postcode | string | Address post code or zip code |
AccountRegistrationNumber | string | Account registration number |
TelNo | string | Telephone number |
FaxNo1 | string | Fax number 1 |
FaxNo2 | string | Fax number 2 |
string | Email address | |
PaymentDays | int | Number of payment days |
Notes | string | Custom notes |
IsCreditAccount | boolean | Is this a credit account |
IsOnHold | boolean | Is this account on hold |
CreditLimit | decimal | Credit limit |
StudentID | string | Student ID, if applicable |
Request URL
https://pmsws.eu.guestline.net/rlxsoaprouter/rlxsoap.asmx?op=cim_GetAccountsRequest headers
Name | Type | Description |
---|---|---|
(optional) | string | Media type of the body sent to the API. |
Request body
<cim_GetAccounts xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionID>string</SessionID>
<likeAccountRef>string</likeAccountRef>
<likeAccountName>string</likeAccountName>
<likeStreet>string</likeStreet>
<likeArea>string</likeArea>
<likeTown>string</likeTown>
<likeCounty>string</likeCounty>
<likeCountry>string</likeCountry>
<likePostcode>string</likePostcode>
<likeTelNo>string</likeTelNo>
<likeEmail>string</likeEmail>
<limit>int</limit>
<likeStudentID>string</likeStudentID>
<accounts>
</accounts>
<LinkedToCompany>string</LinkedToCompany>
<LinkedToProfile>string</LinkedToProfile>
</cim_GetAccounts>
Responses
200 OK
Representations
<cim_GetAccountsResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<cim_GetAccountsResult>
<ExceptionCode>int</ExceptionCode>
<ExceptionDescription>string</ExceptionDescription>
</cim_GetAccountsResult>
<accounts>
<Items>
<CIMAccount>
<Reference>string</Reference>
<Name>string</Name>
<LinkedToProfileRef>string</LinkedToProfileRef>
<LinkedToCompanyRef>string</LinkedToCompanyRef>
<DefaultAddressType>LinkedAddress or CustomAddress</DefaultAddressType>
<Street>string</Street>
<Area>string</Area>
<Town>string</Town>
<County>string</County>
<Country>string</Country>
<Postcode>string</Postcode>
<AccountRegistrationNumber>string</AccountRegistrationNumber>
<TelNo>string</TelNo>
<FaxNo1>string</FaxNo1>
<FaxNo2>string</FaxNo2>
<Email>string</Email>
<PaymentDays>int</PaymentDays>
<Notes>string</Notes>
<IsCreditAccount>boolean</IsCreditAccount>
<IsOnHold>boolean</IsOnHold>
<CreditLimit>decimal</CreditLimit>
<StudentID>string</StudentID>
</CIMAccount>
<CIMAccount>
<Reference>string</Reference>
<Name>string</Name>
<LinkedToProfileRef>string</LinkedToProfileRef>
<LinkedToCompanyRef>string</LinkedToCompanyRef>
<DefaultAddressType>LinkedAddress or CustomAddress</DefaultAddressType>
<Street>string</Street>
<Area>string</Area>
<Town>string</Town>
<County>string</County>
<Country>string</Country>
<Postcode>string</Postcode>
<AccountRegistrationNumber>string</AccountRegistrationNumber>
<TelNo>string</TelNo>
<FaxNo1>string</FaxNo1>
<FaxNo2>string</FaxNo2>
<Email>string</Email>
<PaymentDays>int</PaymentDays>
<Notes>string</Notes>
<IsCreditAccount>boolean</IsCreditAccount>
<IsOnHold>boolean</IsOnHold>
<CreditLimit>decimal</CreditLimit>
<StudentID>string</StudentID>
</CIMAccount>
</Items>
</accounts>
</cim_GetAccountsResponse>
Code samples
@ECHO OFF
curl -v -X POST "https://pmsws.eu.guestline.net/rlxsoaprouter/rlxsoap.asmx?op=cim_GetAccounts"
-H "Content-Type: text/xml"
--data-ascii "{body}"
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;
namespace CSHttpClientSample
{
static class Program
{
static void Main()
{
MakeRequest();
Console.WriteLine("Hit ENTER to exit...");
Console.ReadLine();
}
static async void MakeRequest()
{
var client = new HttpClient();
var queryString = HttpUtility.ParseQueryString(string.Empty);
// Request headers
var uri = "https://pmsws.eu.guestline.net/rlxsoaprouter/rlxsoap.asmx?op=cim_GetAccounts&" + queryString;
HttpResponseMessage response;
// Request body
byte[] byteData = Encoding.UTF8.GetBytes("{body}");
using (var content = new ByteArrayContent(byteData))
{
content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
response = await client.PostAsync(uri, content);
}
}
}
}
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
public class JavaSample
{
public static void main(String[] args)
{
HttpClient httpclient = HttpClients.createDefault();
try
{
URIBuilder builder = new URIBuilder("https://pmsws.eu.guestline.net/rlxsoaprouter/rlxsoap.asmx?op=cim_GetAccounts");
URI uri = builder.build();
HttpPost request = new HttpPost(uri);
request.setHeader("Content-Type", "text/xml");
// Request body
StringEntity reqEntity = new StringEntity("{body}");
request.setEntity(reqEntity);
HttpResponse response = httpclient.execute(request);
HttpEntity entity = response.getEntity();
if (entity != null)
{
System.out.println(EntityUtils.toString(entity));
}
}
catch (Exception e)
{
System.out.println(e.getMessage());
}
}
}
<!DOCTYPE html>
<html>
<head>
<title>JSSample</title>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>
<script type="text/javascript">
$(function() {
var params = {
// Request parameters
};
$.ajax({
url: "https://pmsws.eu.guestline.net/rlxsoaprouter/rlxsoap.asmx?op=cim_GetAccounts" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Content-Type","text/xml");
},
type: "POST",
// Request body
data: "{body}",
})
.done(function(data) {
alert("success");
})
.fail(function() {
alert("error");
});
});
</script>
</body>
</html>
#import <Foundation/Foundation.h>
int main(int argc, const char * argv[])
{
NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
NSString* path = @"https://pmsws.eu.guestline.net/rlxsoaprouter/rlxsoap.asmx?op=cim_GetAccounts";
NSArray* array = @[
// Request parameters
@"entities=true",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"POST"];
// Request headers
[_request setValue:@"text/xml" forHTTPHeaderField:@"Content-Type"];
// Request body
[_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
NSURLResponse *response = nil;
NSError *error = nil;
NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];
if (nil != error)
{
NSLog(@"Error: %@", error);
}
else
{
NSError* error = nil;
NSMutableDictionary* json = nil;
NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
NSLog(@"%@", dataString);
if (nil != _connectionData)
{
json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
}
if (error || !json)
{
NSLog(@"Could not parse loaded json with error:%@", error);
}
NSLog(@"%@", json);
_connectionData = nil;
}
[pool drain];
return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';
$request = new Http_Request2('https://pmsws.eu.guestline.net/rlxsoaprouter/rlxsoap.asmx?op=cim_GetAccounts');
$url = $request->getUrl();
$headers = array(
// Request headers
'Content-Type' => 'text/xml',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_POST);
// Request body
$request->setBody("{body}");
try
{
$response = $request->send();
echo $response->getBody();
}
catch (HttpException $ex)
{
echo $ex;
}
?>
########### Python 2.7 #############
import httplib, urllib, base64
headers = {
# Request headers
'Content-Type': 'text/xml',
}
params = urllib.urlencode({
})
try:
conn = httplib.HTTPSConnection('pmsws.eu.guestline.net/rlxsoaprouter/rlxsoap.asmx')
conn.request("POST", "cim_GetAccounts%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64
headers = {
# Request headers
'Content-Type': 'text/xml',
}
params = urllib.parse.urlencode({
})
try:
conn = http.client.HTTPSConnection('developers.azure-api.net')
conn.request("POST", "/rezlynx-web-service/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/cim_GetAccounts&%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
require 'net/http'
uri = URI('https://pmsws.eu.guestline.net/rlxsoaprouter/rlxsoap.asmx?op=cim_GetAccounts')
request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'text/xml'
# Request body
request.body = "{body}"
response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
http.request(request)
end
puts response.body