System APIs
This is the email settings for the provided output object definition set by the customer.
| HTTP method | GET |
| URI | https://api.rambase.net/system/output-object-definitions/{outputObjectDefinitionId}/email-settings |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {outputObjectDefinitionId} |
Output object definition identifier
Integer, minimum 100000 |
| Successful HTTP status code | 200 |
| API resource identifier | 1986, version 18 |
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.
| $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.
Status
Output object setting status
>{Integer}</Status>FromEmailSource
This could be either User, Company OR Custom (DOV).
User means get the email address from PER and Company from COM.
Custom means get the email address from the field EMAILFROMADDRESS.
FromEmailAddress
If FromEmailSource is set to Custom then the email from address will be gathered from this field.
>{String}</FromEmailAddress>FromEmailName
If FromEmailSource is set to Custom then the email from name will be gathered from this field.
>{String}</FromEmailName>UsesDefaultAdditionalText
If True then you are using the default additional text
>{Boolean}</UsesDefaultAdditionalText>UsesDefaultContent
If True then you are using the default email content
>{Boolean}</UsesDefaultContent>IsDefaultForOutputControl
Combined with the fields IsOutputForCustomers and IsOutputForSuppliers from OOD you can set what default output control values that should be set when a new customer or supplier is created.
>{Boolean}</IsDefaultForOutputControl>OutputDesignId
Output design identifier
>{Integer}</OutputDesignId>Name
Name of the output design
>{String}</Name>OutputDesignLink
Output design reference
>{String}</OutputDesignLink>OutputDesignId
Test output design identifier
>{Integer}</OutputDesignId>Name
Name of the test output design
>{String}</Name>OutputDesignLink
Test output design reference
>{String}</OutputDesignLink>TestEmployees
Employee id testing the test output design selected
>EmployeeId
Employee identifier
>{Integer}</EmployeeId>Name
Last name of employee
>{String}</Name>FirstName
First name of employee
>{String}</FirstName>EmployeeLink
Employee reference
>{String}</EmployeeLink>Status
Output object setting status
": "{Integer}",FromEmailSource
This could be either User, Company OR Custom (DOV).
User means get the email address from PER and Company from COM.
Custom means get the email address from the field EMAILFROMADDRESS.
FromEmailAddress
If FromEmailSource is set to Custom then the email from address will be gathered from this field.
": "{String}",FromEmailName
If FromEmailSource is set to Custom then the email from name will be gathered from this field.
": "{String}",UsesDefaultAdditionalText
If True then you are using the default additional text
": "{Boolean}",UsesDefaultContent
If True then you are using the default email content
": "{Boolean}",IsDefaultForOutputControl
Combined with the fields IsOutputForCustomers and IsOutputForSuppliers from OOD you can set what default output control values that should be set when a new customer or supplier is created.
": "{Boolean}",OutputDesignId
Output design identifier
": "{Integer}",Name
Name of the output design
": "{String}",OutputDesignLink
Output design reference
": "{String}"OutputDesignId
Test output design identifier
": "{Integer}",Name
Name of the test output design
": "{String}",OutputDesignLink
Test output design reference
": "{String}"TestEmployees
Employee id testing the test output design selected
": [EmployeeId
Employee identifier
": "{Integer}",Name
Last name of employee
": "{String}",FirstName
First name of employee
": "{String}",EmployeeLink
Employee reference
": "{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 101109 HTTP 404 | Output design not found |