API

System APIs

PUT system/print-configurations/{printConfigurationId}/exceptions/{exceptionId}

Update exception of given configuration

HTTP method PUT
URI https://api.rambase.net/system/print-configurations/{printConfigurationId}/exceptions/{exceptionId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {printConfigurationId} Print configuration identifier
Integer, minimum 100000
- URI parameter {exceptionId} Print configuration exception identifier
Integer, minimum 1
Successful HTTP status code 200
API resource identifier 1890, version 17

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

This field is optional.

>
2
     <Company
Company

This field is optional.

>
3
          <Database
Database

Company where you want to route print differently

This field is optional.

>{String}</Database>
4
     </Company>
5
     <OutputObjectDefinition
OutputObjectDefinition

This field is optional.

>
6
          <OutputObjectDefinitionId
OutputObjectDefinitionId

Output object definition identifier

Minimum value: 100000

This field is optional.

>{Integer}</OutputObjectDefinitionId>
7
     </OutputObjectDefinition>
8
     <OutputDesign
OutputDesign

This field is optional.

>
9
          <OutputDesignId
OutputDesignId

Reference to the design object

Minimum value: 100000

This field is optional.

>{Integer}</OutputDesignId>
10
     </OutputDesign>
11
     <RedirectTo
RedirectTo

This field is optional.

>
12
          <PrinterId
PrinterId

Identifier of the printer

Minimum value: 1

This field is optional.

>{Integer}</PrinterId>
13
          <PrintConnector
PrintConnector

This field is optional.

>
14
               <PrintConnectorId
PrintConnectorId

Print connector identifier

Minimum value: 100000

This field is optional.

>{Integer}</PrintConnectorId>
15
          </PrintConnector>
16
     </RedirectTo>
17
     <StopPrinting
StopPrinting

If this value is true no print should be triggered for the given object definition

This field is optional.

>{Boolean}</StopPrinting>
18
</Exception>
1
{
2
     "exception
Exception

This field is optional.

": {
3
          "company
Company

This field is optional.

": {
4
               "database
Database

Company where you want to route print differently

This field is optional.

": "{String}"
5
          },
6
          "outputObjectDefinition
OutputObjectDefinition

This field is optional.

": {
7
               "outputObjectDefinitionId
OutputObjectDefinitionId

Output object definition identifier

Minimum value: 100000

This field is optional.

": "{Integer}"
8
          },
9
          "outputDesign
OutputDesign

This field is optional.

": {
10
               "outputDesignId
OutputDesignId

Reference to the design object

Minimum value: 100000

This field is optional.

": "{Integer}"
11
          },
12
          "redirectTo
RedirectTo

This field is optional.

": {
13
               "printerId
PrinterId

Identifier of the printer

Minimum value: 1

This field is optional.

": "{Integer}",
14
               "printConnector
PrintConnector

This field is optional.

": {
15
                    "printConnectorId
PrintConnectorId

Print connector identifier

Minimum value: 100000

This field is optional.

": "{Integer}"
16
               }
17
          },
18
          "stopPrinting
StopPrinting

If this value is true no print should be triggered for the given object definition

This field is optional.

": "{Boolean}"
19
     }
20
}

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 100036 HTTP 400 Missing required input parameter: {0}
Error 101406 HTTP 400 Exeption already exists for this print configuration