Sales APIs
Details of output condition
| HTTP method | GET |
| URI | https://api.rambase.net/sales/customers/{customerId}/output-control/{outputConditionId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {customerId} |
Customer identifier
Integer, minimum 10000 |
| - URI parameter {outputConditionId} |
Output condition identifier
Integer, minimum 1 |
| Successful HTTP status code | 200 |
| API resource identifier | 2203, 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.
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.
| $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] |
| $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. |
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.
OutputConditionId
Output condition identifier
>{Integer}</OutputConditionId>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>IsMandatory
True if output is mandatory, and cannot be removed from the output object
>{Boolean}</IsMandatory>NumberOfCopies
Number of copies to output
>{Integer}</NumberOfCopies>OutputObjectDefinitionId
Output object definition identifier
>{Integer}</OutputObjectDefinitionId>Name
Name of the Output Object
>{String}</Name>Description
Description of the Output Object Definition
>{String}</Description>OutputObjectDefinitionLink
Output object definition reference
>{String}</OutputObjectDefinitionLink>OutputDesignId
Output design identifier
>{Integer}</OutputDesignId>Name
Name of the output design
>{String}</Name>OutputDesignLink
Output design reference
>{String}</OutputDesignLink>Recipient
The destination of the output
>Details
Details of recipient. Ex. the email address when output by is EMAIL.
>{String}</Details>ObjectType
Type of object
>{String}</ObjectType>ObjectId
Identifier of the object
>{Integer}</ObjectId>ObjectLink
API reference to the object
>{String}</ObjectLink>ItemId
Item-number of the object
>{Integer}</ItemId>ItemType
Type of item
>{String}</ItemType>ItemLink
API reference to the item
>{String}</ItemLink>OutputConditionId
Output condition identifier
": "{Integer}",OutputBy
Output type
Possible domain values can be found here
": "{String}",CreatedAt
Date and time of creation
": "{Datetime}",IsMandatory
True if output is mandatory, and cannot be removed from the output object
": "{Boolean}",NumberOfCopies
Number of copies to output
": "{Integer}",OutputObjectDefinitionId
Output object definition identifier
": "{Integer}",Name
Name of the Output Object
": "{String}",Description
Description of the Output Object Definition
": "{String}",OutputObjectDefinitionLink
Output object definition reference
": "{String}"OutputDesignId
Output design identifier
": "{Integer}",Name
Name of the output design
": "{String}",OutputDesignLink
Output design reference
": "{String}"Recipient
The destination of the output
": {Details
Details of recipient. Ex. the email address when output by is EMAIL.
": "{String}",ObjectType
Type of object
": "{String}",ObjectId
Identifier of the object
": "{Integer}",ObjectLink
API reference to the object
": "{String}",ItemId
Item-number of the object
": "{Integer}",ItemType
Type of item
": "{String}",ItemLink
API reference to the item
": "{String}"
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 101114 HTTP 404 | Output object setting not found |
| Error 100055 HTTP 403 | You have only admittance to your own objects |