System APIs
Creates a new exception record for given configuration
| HTTP method | POST |
| URI | https://api.rambase.net/system/print-configurations/{printConfigurationId}/exceptions |
| 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 | 1888, version 22 |
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.
Company
This field is optional.
>Database
Company where you want to route print differently
This field is optional.
>{String}</Database>OutputObjectDefinitionId
Required/mandatory field
Output object definition identifier
Minimum value: 100000
>{Integer}</OutputObjectDefinitionId>OutputDesign
This field is optional.
>OutputDesignId
Reference to the design object
Minimum value: 100000
This field is optional.
>{Integer}</OutputDesignId>RedirectTo
This field is optional.
>PrinterId
Identifier of the printer
Minimum value: 1
This field is optional.
>{Integer}</PrinterId>PrintConnector
This field is optional.
>PrintConnectorId
Print connector identifier
Minimum value: 100000
This field is optional.
>{Integer}</PrintConnectorId>StopPrinting
If this value is true no print should be triggered for the given object definition
Default value: False
This field is optional.
>{Boolean}</StopPrinting>Company
This field is optional.
": {Database
Company where you want to route print differently
This field is optional.
": "{String}"OutputObjectDefinitionId
Required/mandatory field
Output object definition identifier
Minimum value: 100000
": "{Integer}"OutputDesign
This field is optional.
": {OutputDesignId
Reference to the design object
Minimum value: 100000
This field is optional.
": "{Integer}"RedirectTo
This field is optional.
": {PrinterId
Identifier of the printer
Minimum value: 1
This field is optional.
": "{Integer}",PrintConnector
This field is optional.
": {PrintConnectorId
Print connector identifier
Minimum value: 100000
This field is optional.
": "{Integer}"StopPrinting
If this value is true no print should be triggered for the given object definition
Default value: False
This field is optional.
": "{Boolean}"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.
ExceptionId
Print configuration exception identifier
>{Integer}</ExceptionId>CompanyId
Company identifier
>{Integer}</CompanyId>Name
Name of the company where you want to route print differently
>{String}</Name>Database
Company where you want to route print differently
>{String}</Database>CompanyLink
Company reference
>{String}</CompanyLink>OutputObjectDefinitionId
Output object definition identifier
>{Integer}</OutputObjectDefinitionId>OutputObjectDefinitionLink
Output object definition reference
>{String}</OutputObjectDefinitionLink>OutputDesignId
Reference to the design object
>{Integer}</OutputDesignId>Name
Name of the output design
>{String}</Name>OutputDesignLink
Output design reference
>{String}</OutputDesignLink>PrinterId
Identifier of the printer
>{Integer}</PrinterId>Name
Name of the printer
>{String}</Name>PrintConnectorId
Print connector identifier
>{Integer}</PrintConnectorId>Name
Readable name of the print connector
>{String}</Name>PrintConnectorLink
Reference to the print connector
>{String}</PrintConnectorLink>PrinterLink
Reference to the printer
>{String}</PrinterLink>StopPrinting
If this value is true no print should be triggered for the given object definition
>{Boolean}</StopPrinting>ExceptionId
Print configuration exception identifier
": "{Integer}",CompanyId
Company identifier
": "{Integer}",Name
Name of the company where you want to route print differently
": "{String}",Database
Company where you want to route print differently
": "{String}",CompanyLink
Company reference
": "{String}"OutputObjectDefinitionId
Output object definition identifier
": "{Integer}",OutputObjectDefinitionLink
Output object definition reference
": "{String}"OutputDesignId
Reference to the design object
": "{Integer}",Name
Name of the output design
": "{String}",OutputDesignLink
Output design reference
": "{String}"PrinterId
Identifier of the printer
": "{Integer}",Name
Name of the printer
": "{String}",PrintConnectorId
Print connector identifier
": "{Integer}",Name
Readable name of the print connector
": "{String}",PrintConnectorLink
Reference to the print connector
": "{String}"PrinterLink
Reference to the printer
": "{String}"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 100990 HTTP 404 | Print Configuration not found |
| Error 100989 HTTP 404 | Output Object Definition not found |
| Error 101406 HTTP 400 | Exeption already exists for this print configuration |