API

System APIs

PUT system/print-connectors/{printConnectorId}

Update information of provided identifier

HTTP method PUT
URI https://api.rambase.net/system/print-connectors/{printConnectorId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {printConnectorId} Print connector identifier
Integer, minimum 100000
Successful HTTP status code 200
API resource identifier 410, version 12

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
<PrintConnector
PrintConnector

This field is optional.

>
2
     <Name
Name

Readable name of the print connector

This field is optional.

>
{String}</Name>
3
     <Version
Version

Software version of the print connector

This field is optional.

>
{String}</Version>
4
     <IsOnline
IsOnline

If true it means that the print connector is online and connected to RamBase.
False means that there is no connection between RamBase and the machine the print connector is installed on.

This field is optional.

>
{Boolean}</IsOnline>
5
     <License
License

This is the unique license of the print connector

This field is optional.

>
{String}</License>
6
     <State
State

State of PrintConnector. Updated after fresh install by Cloud and continously report from Cloud on the current state of a Connector.

This field is optional.

>
{String}</State>
7
     <InstalledBy
InstalledBy

The employee that installed the print connector

This field is optional.

>
8
          <EmployeeId
EmployeeId

Employee identifier

Minimum value: 100

This field is optional.

>
{Integer}</EmployeeId>
9
     </InstalledBy>
10
     <Server
Server

This field is optional.

>
11
          <IPAddress
IPAddress

IP address of the server the print connector is intalled on

This field is optional.

>
{String}</IPAddress>
12
          <MACAddress
MACAddress

MAC address of the server the print connector is intalled on

This field is optional.

>
{String}</MACAddress>
13
          <ComputerName
ComputerName

Computer name of the server the print connector is installed on

This field is optional.

>
{String}</ComputerName>
14
          <OperatingSystem
OperatingSystem

Operating system of the server the print connector is installed on

This field is optional.

>
{String}</OperatingSystem>
15
     </Server>
16
</PrintConnector>
1
{
2
     "printConnector
PrintConnector

This field is optional.

":
{
3
          "name
Name

Readable name of the print connector

This field is optional.

":
"{String}",
4
          "version
Version

Software version of the print connector

This field is optional.

":
"{String}",
5
          "isOnline
IsOnline

If true it means that the print connector is online and connected to RamBase.
False means that there is no connection between RamBase and the machine the print connector is installed on.

This field is optional.

":
"{Boolean}",
6
          "license
License

This is the unique license of the print connector

This field is optional.

":
"{String}",
7
          "state
State

State of PrintConnector. Updated after fresh install by Cloud and continously report from Cloud on the current state of a Connector.

This field is optional.

":
"{String}",
8
          "installedBy
InstalledBy

The employee that installed the print connector

This field is optional.

":
{
9
               "employeeId
EmployeeId

Employee identifier

Minimum value: 100

This field is optional.

":
"{Integer}"
10
          },
11
          "server
Server

This field is optional.

":
{
12
               "iPAddress
IPAddress

IP address of the server the print connector is intalled on

This field is optional.

":
"{String}",
13
               "mACAddress
MACAddress

MAC address of the server the print connector is intalled on

This field is optional.

":
"{String}",
14
               "computerName
ComputerName

Computer name of the server the print connector is installed on

This field is optional.

":
"{String}",
15
               "operatingSystem
OperatingSystem

Operating system of the server the print connector is installed on

This field is optional.

":
"{String}"
16
          }
17
     }
18
}

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
1

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 101079 HTTP 400 Mismatch in size of revision parameters