API

System APIs

POST system/batch-print-exceptions

Creates a new record for exception of batch print routing

HTTP method POST
URI https://api.rambase.net/system/batch-print-exceptions
Supported formats Xml, Html, Json (ex. $format=json)
Successful HTTP status code 201
API resource identifier 1945, version 3

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
<BatchPrintException>
2
     <OutputObjectDefinition>
3
          <OutputObjectDefinitionId
OutputObjectDefinitionId

Required/mandatory field

Output object definition identifier

>{Integer}</OutputObjectDefinitionId>
4
     </OutputObjectDefinition>
5
     <RedirectTo>
6
          <PrintConfigurationId
PrintConfigurationId

Required/mandatory field

Print configuration identifier

>{Integer}</PrintConfigurationId>
7
     </RedirectTo>
8
</BatchPrintException>
1
{
2
     "batchPrintException": {
3
          "outputObjectDefinition": {
4
               "outputObjectDefinitionId
OutputObjectDefinitionId

Required/mandatory field

Output object definition identifier

": "{Integer}"
5
          },
6
          "redirectTo": {
7
               "printConfigurationId
PrintConfigurationId

Required/mandatory field

Print configuration identifier

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

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
<BatchPrintException>
2
     <BatchPrintExceptionId
BatchPrintExceptionId

Batch print exception identifier

>{Integer}</BatchPrintExceptionId>
3
     <OutputObjectDefinition>
4
          <OutputObjectDefinitionId
OutputObjectDefinitionId

Output object definition identifier

>{Integer}</OutputObjectDefinitionId>
5
          <OutputObjectDefinitionLink
OutputObjectDefinitionLink

Output object definition reference

>{String}</OutputObjectDefinitionLink>
6
     </OutputObjectDefinition>
7
     <RedirectTo>
8
          <PrintConfigurationId
PrintConfigurationId

Print configuration identifier

>{Integer}</PrintConfigurationId>
9
          <PrintConfigurationLink
PrintConfigurationLink

Print configuration reference

>{String}</PrintConfigurationLink>
10
     </RedirectTo>
11
</BatchPrintException>
1
{
2
     "batchPrintException": {
3
          "batchPrintExceptionId
BatchPrintExceptionId

Batch print exception identifier

": "{Integer}",
4
          "outputObjectDefinition": {
5
               "outputObjectDefinitionId
OutputObjectDefinitionId

Output object definition identifier

": "{Integer}",
6
               "outputObjectDefinitionLink
OutputObjectDefinitionLink

Output object definition reference

": "{String}"
7
          },
8
          "redirectTo": {
9
               "printConfigurationId
PrintConfigurationId

Print configuration identifier

": "{Integer}",
10
               "printConfigurationLink
PrintConfigurationLink

Print configuration reference

": "{String}"
11
          }
12
     }
13
}

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 101079 HTTP 400 Mismatch in size of revision parameters