API

Base APIs

POST base/rooms/{roomId}/print-destinations

Creates a new record of destination for printing in given room

HTTP method POST
URI https://api.rambase.net/base/rooms/{roomId}/print-destinations
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {roomId} Identifier of the room
Integer, minimum 100000
Successful HTTP status code 201
API resource identifier 1939, version 8

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
<PrintDestination>
2
     <PaperSize
PaperSize

Size of paper used in the printer

This field is optional.

>{String}</PaperSize>
3
     <Printer>
4
          <PrinterId
PrinterId

Required/mandatory field

Identifier of the printer

>{Integer}</PrinterId>
5
          <PrintConnector>
6
               <PrintConnectorId
PrintConnectorId

Required/mandatory field

Print connector identifier

>{Integer}</PrintConnectorId>
7
          </PrintConnector>
8
     </Printer>
9
</PrintDestination>
1
{
2
     "printDestination": {
3
          "paperSize
PaperSize

Size of paper used in the printer

This field is optional.

": "{String}",
4
          "printer": {
5
               "printerId
PrinterId

Required/mandatory field

Identifier of the printer

": "{Integer}",
6
               "printConnector": {
7
                    "printConnectorId
PrintConnectorId

Required/mandatory field

Print connector identifier

": "{Integer}"
8
               }
9
          }
10
     }
11
}

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.
$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:
1
<PrintDestination>
2
     <PrintDestinationId
PrintDestinationId

Identifier of printer-link of a room

>{Integer}</PrintDestinationId>
3
     <PaperSize
PaperSize

Size of paper used in the printer

>{String}</PaperSize>
4
     <Printer>
5
          <PrinterId
PrinterId

Identifier of the printer

>{Integer}</PrinterId>
6
          <PrintConnector>
7
               <PrintConnectorId
PrintConnectorId

Print connector identifier

>{Integer}</PrintConnectorId>
8
               <PrintConnectorLink
PrintConnectorLink

Reference to the print connector

>{String}</PrintConnectorLink>
9
          </PrintConnector>
10
          <PrinterLink
PrinterLink

Reference to the printer

>{String}</PrinterLink>
11
     </Printer>
12
</PrintDestination>
1
{
2
     "printDestination": {
3
          "printDestinationId
PrintDestinationId

Identifier of printer-link of a room

": "{Integer}",
4
          "paperSize
PaperSize

Size of paper used in the printer

": "{String}",
5
          "printer": {
6
               "printerId
PrinterId

Identifier of the printer

": "{Integer}",
7
               "printConnector": {
8
                    "printConnectorId
PrintConnectorId

Print connector identifier

": "{Integer}",
9
                    "printConnectorLink
PrintConnectorLink

Reference to the print connector

": "{String}"
10
               },
11
               "printerLink
PrinterLink

Reference to the printer

": "{String}"
12
          }
13
     }
14
}

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: