System APIs

POST system/print-connectors

Creates a new print connector

HTTP method	POST
URI	https://api.rambase.net/system/print-connectors
Supported formats	Xml, Html, Json (ex. $format=json)
Successful HTTP status code	201
API resource identifier	1801, version 10

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:

                                        <PrintConnector>
                                    

<Name

Name

Required/mandatory field

Readable name of the print connector

>{String}</Name>

<Version

Version

Software version of the print connector

This field is optional.

>{String}</Version>

<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.

Default value: True

This field is optional.

>{Boolean}</IsOnline>

<License

License

This is the unique license of the print connector

This field is optional.

>{String}</License>

<InstalledBy

InstalledBy

Required/mandatory field

The employee that installed the print connector

<EmployeeId

EmployeeId

Required/mandatory field

Employee identifier

Minimum value: 100

>{Integer}</EmployeeId>

                                             </InstalledBy>
                                    

<Server

Server

This field is optional.

<IPAddress

IPAddress

IP address of the server the print connector is intalled on

This field is optional.

>{String}</IPAddress>

<MACAddress

MACAddress

MAC address of the server the print connector is intalled on

This field is optional.

>{String}</MACAddress>

<ComputerName

ComputerName

Computer name of the server the print connector is installed on

This field is optional.

>{String}</ComputerName>

<OperatingSystem

OperatingSystem

Operating system of the server the print connector is installed on

This field is optional.

>{String}</OperatingSystem>

                                             </Server>
                                    

                                        </PrintConnector>
                                    

{

                                             "printConnector": {
                                    

"name

Name

Required/mandatory field

Readable name of the print connector

": "{String}",

"version

Version

Software version of the print connector

This field is optional.

": "{String}",

"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.

Default value: True

This field is optional.

": "{Boolean}",

"license

License

This is the unique license of the print connector

This field is optional.

": "{String}",

"installedBy

InstalledBy

Required/mandatory field

The employee that installed the print connector

": {

"employeeId

EmployeeId

Required/mandatory field

Employee identifier

Minimum value: 100

": "{Integer}"

},

"server

Server

This field is optional.

": {

"iPAddress

IPAddress

IP address of the server the print connector is intalled on

This field is optional.

": "{String}",

"mACAddress

MACAddress

MAC address of the server the print connector is intalled on

This field is optional.

": "{String}",

"computerName

ComputerName

Computer name of the server the print connector is installed on

This field is optional.

": "{String}",

"operatingSystem

OperatingSystem

Operating system of the server the print connector is installed on

This field is optional.

": "{String}"

}

}

}

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.
$showDomainDescriptions Boolean, optional	Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false.
$lang String, optional	Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]

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.

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

Format:

                                        <PrintConnector>
                                    

<PrintConnectorId

PrintConnectorId

Print connector identifier

>{Integer}</PrintConnectorId>

<Status

Status

Status of print connector

Possible domain values can be found here

>{Integer}</Status>

<Name

Name

Readable name of the print connector

>{String}</Name>

<Version

Version

Software version of the print connector

>{String}</Version>

<InstalledAt

InstalledAt

Date and time of creation

>{Datetime}</InstalledAt>

<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.

>{Boolean}</IsOnline>

<License

License

This is the unique license of the print connector

>{String}</License>

<State

State

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

<EmployeeId

EmployeeId

Employee identifier

>{Integer}</EmployeeId>

<LastName

LastName

Last name of employee

>{String}</LastName>

<FirstName

FirstName

First name of employee

>{String}</FirstName>

<EmployeeLink

EmployeeLink

Employee reference

>{String}</EmployeeLink>

                                             </State>
                                    

                                             <Server>
                                    

<IPAddress

IPAddress

IP address of the server the print connector is intalled on

>{String}</IPAddress>

<MACAddress

MACAddress

MAC address of the server the print connector is intalled on

>{String}</MACAddress>

<ComputerName

ComputerName

Computer name of the server the print connector is installed on

>{String}</ComputerName>

<OperatingSystem

OperatingSystem

Operating system of the server the print connector is installed on

>{String}</OperatingSystem>

                                             </Server>
                                    

                                        </PrintConnector>
                                    

{

                                             "printConnector": {
                                    

"printConnectorId

PrintConnectorId

Print connector identifier

": "{Integer}",

"status

Status

Status of print connector

Possible domain values can be found here

": "{Integer}",

"name

Name

Readable name of the print connector

": "{String}",

"version

Version

Software version of the print connector

": "{String}",

"installedAt

InstalledAt

Date and time of creation

": "{Datetime}",

"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.

": "{Boolean}",

"license

License

This is the unique license of the print connector

": "{String}",

"state

State

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

": {

"employeeId

EmployeeId

Employee identifier

": "{Integer}",

"lastName

LastName

Last name of employee

": "{String}",

"firstName

FirstName

First name of employee

": "{String}",

"employeeLink

EmployeeLink

Employee reference

": "{String}"

},

                                                  "server": {
                                    

"iPAddress

IPAddress

IP address of the server the print connector is intalled on

": "{String}",

"mACAddress

MACAddress

MAC address of the server the print connector is intalled on

": "{String}",

"computerName

ComputerName

Computer name of the server the print connector is installed on

": "{String}",

"operatingSystem

OperatingSystem

Operating system of the server the print connector is installed on

": "{String}"

}

}

}

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 101015 HTTP 404	Permission not found
Error 101420 HTTP 404	Setting definition not found