API

System APIs

POST system/print-configurations/{printConfigurationId}/prioritized-printers

Creates a new printer record for given configuration

HTTP method POST
URI https://api.rambase.net/system/print-configurations/{printConfigurationId}/prioritized-printers
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {printConfigurationId} Print configuration identifier
Integer, minimum 100000
Successful HTTP status code 201
API resource identifier 2557, version 6

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
<PrioritizedPrinter>
2
     <Priority
Priority

The order the printeres will be checked for a match

This field is optional.

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

Size of paper used by the printer

Applicable domain values can be found here

This field is optional.

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

Required/mandatory field

Identifier of the printer

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

Required/mandatory field

Print connector identifier

>{Integer}</PrintConnectorId>
8
          </PrintConnector>
9
     </Printer>
10
</PrioritizedPrinter>
1
{
2
     "prioritizedPrinter": {
3
          "priority
Priority

The order the printeres will be checked for a match

This field is optional.

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

Size of paper used by the printer

Applicable domain values can be found here

This field is optional.

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

Required/mandatory field

Identifier of the printer

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

Required/mandatory field

Print connector identifier

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

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:
1
<PrioritizedPrinter>
2
     <PrioritizedPrinterId
PrioritizedPrinterId

Print configuration printer identifier

>{Integer}</PrioritizedPrinterId>
3
     <Priority
Priority

The order the printeres will be checked for a match

>{Integer}</Priority>
4
     <PaperSize
PaperSize

Size of paper used by the printer

Possible domain values can be found here

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

Identifier of the printer

>{Integer}</PrinterId>
7
          <Name
Name

Name of the printer

>{String}</Name>
8
          <PrintConnector>
9
               <PrintConnectorId
PrintConnectorId

Print connector identifier

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

Reference to the print connector

>{String}</PrintConnectorLink>
11
          </PrintConnector>
12
          <PrinterLink
PrinterLink

Reference to the printer

>{String}</PrinterLink>
13
     </Printer>
14
</PrioritizedPrinter>
1
{
2
     "prioritizedPrinter": {
3
          "prioritizedPrinterId
PrioritizedPrinterId

Print configuration printer identifier

": "{Integer}",
4
          "priority
Priority

The order the printeres will be checked for a match

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

Size of paper used by the printer

Possible domain values can be found here

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

Identifier of the printer

": "{Integer}",
8
               "name
Name

Name of the printer

": "{String}",
9
               "printConnector": {
10
                    "printConnectorId
PrintConnectorId

Print connector identifier

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

Reference to the print connector

": "{String}"
12
               },
13
               "printerLink
PrinterLink

Reference to the printer

": "{String}"
14
          }
15
     }
16
}

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 100667 HTTP 404 Print connector not found
Error 100830 HTTP 400 Printer not found