API

System APIs

GET system/output-object-definitions/{outputObjectDefinitionId}/email-settings/defaults

Email settings for the provided output object definition

HTTP method GET
URI https://api.rambase.net/system/output-object-definitions/{outputObjectDefinitionId}/email-settings/defaults
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 1978, version 7

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
1

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:
1
<EmailSettings>
2
     <FromEmailSource
FromEmailSource

Default from email type. This could be either User or Company (DOV).

User means get the email address from PER and Company from COM.

>{String}</FromEmailSource>
3
     <IsActivatedManually
IsActivatedManually

If set to True this output setting can only be activated manually and not by the turn on all outputs option.

>{Boolean}</IsActivatedManually>
4
     <OutputDesign>
5
          <OutputDesignId
OutputDesignId

Output design identifier

>{Integer}</OutputDesignId>
6
          <Name
Name

Name of the output design

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

>{String}</Name>
7
          <OutputDesignLink
OutputDesignLink

Output design reference

>{String}</OutputDesignLink>
8
     </OutputDesign>
9
</EmailSettings>
1
{
2
     "emailSettings": {
3
          "fromEmailSource
FromEmailSource

Default from email type. This could be either User or Company (DOV).

User means get the email address from PER and Company from COM.

": "{String}",
4
          "isActivatedManually
IsActivatedManually

If set to True this output setting can only be activated manually and not by the turn on all outputs option.

": "{Boolean}",
5
          "outputDesign": {
6
               "outputDesignId
OutputDesignId

Output design identifier

": "{Integer}",
7
               "name
Name

Name of the output design

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

": "{String}",
8
               "outputDesignLink
OutputDesignLink

Output design reference

": "{String}"
9
          }
10
     }
11
}

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 101049 HTTP 404 Output format not found