System APIs

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

Get specified exception for given print configuration

HTTP method	GET
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	1889, version 20

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:

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.

$lang String, optional	Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]
$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
$format String, optional	Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$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.
$select String, optional	Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$expand String, optional	Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select 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:

                                        <Exception>
                                    

<ExceptionId

ExceptionId

Print configuration exception identifier

>{Integer}</ExceptionId>

                                             <Company>
                                    

<CompanyId

CompanyId

Company identifier

>{Integer}</CompanyId>

<Name

Name

Name of the company where you want to route print differently

>{String}</Name>

<Database

Database

Company where you want to route print differently

>{String}</Database>

<CompanyLink

CompanyLink

Company reference

>{String}</CompanyLink>

                                             </Company>
                                    

                                             <OutputObjectDefinition>
                                    

<OutputObjectDefinitionId

OutputObjectDefinitionId

Output object definition identifier

>{Integer}</OutputObjectDefinitionId>

<Name

Name

Name of the Output Object

This field is greyed out because it is an expandable field. You have to add $expand=OutputObjectDefinition.Name in your request URI to get this field

>{String}</Name>

<OutputObjectDefinitionLink

OutputObjectDefinitionLink

Output object definition reference

>{String}</OutputObjectDefinitionLink>

                                             </OutputObjectDefinition>
                                    

                                             <OutputDesign>
                                    

<OutputDesignId

OutputDesignId

Reference to the design object

>{Integer}</OutputDesignId>

<Name

Name

Name of the output design

>{String}</Name>

<OutputDesignLink

OutputDesignLink

Output design reference

>{String}</OutputDesignLink>

                                             </OutputDesign>
                                    

                                             <RedirectTo>
                                    

<PrinterId

PrinterId

Identifier of the printer

>{Integer}</PrinterId>

<Name

Name

Name of the printer

>{String}</Name>

                                                  <PrintConnector>
                                    

<PrintConnectorId

PrintConnectorId

Print connector identifier

>{Integer}</PrintConnectorId>

<Name

Name

Readable name of the print connector

>{String}</Name>

<PrintConnectorLink

PrintConnectorLink

Reference to the print connector

>{String}</PrintConnectorLink>

                                                  </PrintConnector>
                                    

<PrinterLink

PrinterLink

Reference to the printer

>{String}</PrinterLink>

                                             </RedirectTo>
                                    

<StopPrinting

StopPrinting

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

>{Boolean}</StopPrinting>

                                        </Exception>
                                    

{

                                             "exception": {
                                    

"exceptionId

ExceptionId

Print configuration exception identifier

": "{Integer}",

                                                  "company": {
                                    

"companyId

CompanyId

Company identifier

": "{Integer}",

"name

Name

Name of the company where you want to route print differently

": "{String}",

"database

Database

Company where you want to route print differently

": "{String}",

"companyLink

CompanyLink

Company reference

": "{String}"

},

                                                  "outputObjectDefinition": {
                                    

"outputObjectDefinitionId

OutputObjectDefinitionId

Output object definition identifier

": "{Integer}",

"name

Name

Name of the Output Object

This field is greyed out because it is an expandable field. You have to add $expand=OutputObjectDefinition.Name in your request URI to get this field

": "{String}",

"outputObjectDefinitionLink

OutputObjectDefinitionLink

Output object definition reference

": "{String}"

},

                                                  "outputDesign": {
                                    

"outputDesignId

OutputDesignId

Reference to the design object

": "{Integer}",

"name

Name

Name of the output design

": "{String}",

"outputDesignLink

OutputDesignLink

Output design reference

": "{String}"

},

                                                  "redirectTo": {
                                    

"printerId

PrinterId

Identifier of the printer

": "{Integer}",

"name

Name

Name of the printer

": "{String}",

                                                       "printConnector": {
                                    

"printConnectorId

PrintConnectorId

Print connector identifier

": "{Integer}",

"name

Name

Readable name of the print connector

": "{String}",

"printConnectorLink

PrintConnectorLink

Reference to the print connector

": "{String}"

},

"printerLink

PrinterLink

Reference to the printer

": "{String}"

},

"stopPrinting

StopPrinting

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

": "{Boolean}"

}

}

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 100998 HTTP 404

Exception for print configuration not found