GET base/notification-types

List of notification types

Note: Log in to check if your API client have access to run this resource
Version: 11
Success HTTP Status Code: 200
Maximum items from list ($top): 80

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 is 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.

$inlinecount String, optional Only usable when the result is a list. Set to "allpages" if you want size of the result list to be returned. Accepted values are: "allpages", "none"
$top String, optional Only usable when the result is a list. Set the number of objects to return in result list. Maximum limit is specific for each resource, but is default 80.
$filter String, optional Only usable when the result is a list. Use to filter the result list, see the Filter and OrderBy page for more information about this.
$orderby String, optional Only usable when the result is a list. Use to order the result list, see Filter and OrderBy page for more information about this.
$expand String, optional Use to expand Output fields that are not shown by default in the output result. Possible Expandable fields are listed in the Output tab for the resource. Accepts a comma-separated list of expandable Output Field names. See the Expand and Select page for more information about this.
$showDomainDescriptions Boolean, optional Use to show an additional descriptional field for fields that are using Domain Values.
$select String, optional Use to define the fields to return in the result. Accepts a comma-separated list of Output Field names. See the Expand and Select page for more information about this.
$db String, optional Set the database to use for the request
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "json"
$lang String, optional Use to get localized responses. Supported formats are 3-letter ISO-639-1 [lll], 2-letter ISO-639-2 [ll], or a combination of a two-letter language code and a two-letter country code ISO-639-2 and ISO-3166-1 [ll_CC], [ll-CC]
$useMinimumVersion Integer, optional This can be used to test a new version of a resource when your ApiClient is running an older, deprecated, version of a resource. $useminimumversion can be used to test against a newer version of the resource. See the Deprecated APIs page for more information about this.

See the page about filters and sorting on how to use filter parameters and named filters.

ForProducts() Named filter Notification types used for products. Ex. notification triggers for a product.
Category String Category of notification type (warning, information etc).
ContainingApplicableObject String Applicable object for the notification type.
CreatedAt Datetime Date and time of creation. Available macros: currentDate(), now(), startOfDay(), endOfDay(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
Description String Description of notification definition.
Message String Message of the notification definition.
NotificationTypeId Integer Notification type identifier.
Priority Integer Priority of notification with this notification type.
Status Integer Status of transaction message.
TechnicalDescription String Description/note of the transaction message.

See the page about filters and sorting on how to use sortable parameters

Category String Category of notification type (warning, information etc)
ContainingApplicableObject String Applicable object for the notification type.
CreatedAt Datetime Date and time of creation
Description String Description of notification definition.
Message String Message of the notification definition.
NotificationTypeId Integer Notification type identifier
Priority Integer Priority of notification with this notification type.
Status Integer Status of transaction message.
TechnicalDescription String Description/note of the transaction message.

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
<NotificationTypes>
2
     <NotificationType>
3
          <NotificationTypeId
NotificationTypeId

Notification type identifier

>
{Integer}</NotificationTypeId>
4
          <Status
Status

Status of transaction message.

>
{Integer}</Status>
5
          <CreatedAt
CreatedAt

Date and time of creation

>
{Datetime}</CreatedAt>
6
          <Category
Category

Category of notification type (warning, information etc)

Possible domain values can be found here when logged in

>
{String}</Category>
7
          <Description
Description

Description of notification definition.

>
{String}</Description>
8
          <TechnicalDescription
TechnicalDescription

Description/note of the transaction message.

>
{String}</TechnicalDescription>
9
          <Priority
Priority

Priority of notification with this notification type.

>
{Integer}</Priority>
10
          <Message
Message

Message of the notification definition.

>
{String}</Message>
11
          <TranslatedMessage
TranslatedMessage

The notification definition message in user language.

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

>
{String}</TranslatedMessage>
12
          <AssociatedCompanySettingDefintion
AssociatedCompanySettingDefintion

Company setting definition associated with the notification definiton. Through the company setting, you might be able to disable this kind of notifications.

>
13
               <CompanySettingDefinitionId
CompanySettingDefinitionId

Company setting definition identifier

>
{Integer}</CompanySettingDefinitionId>
14
               <CompanySettingDefinitionLink
CompanySettingDefinitionLink

Company setting definition reference

>
{String}</CompanySettingDefinitionLink>
15
          </AssociatedCompanySettingDefintion>
16
          <NotificationTypeLink
NotificationTypeLink

Notification type reference

>
{String}</NotificationTypeLink>
17
     </NotificationType>
18
</NotificationTypes>
1
{
2
     "notificationTypes": [
3
          {
4
               "notificationTypeId
NotificationTypeId

Notification type identifier

":
"{Integer}",
5
               "status
Status

Status of transaction message.

":
"{Integer}",
6
               "createdAt
CreatedAt

Date and time of creation

":
"{Datetime}",
7
               "category
Category

Category of notification type (warning, information etc)

Possible domain values can be found here when logged in

":
"{String}",
8
               "description
Description

Description of notification definition.

":
"{String}",
9
               "technicalDescription
TechnicalDescription

Description/note of the transaction message.

":
"{String}",
10
               "priority
Priority

Priority of notification with this notification type.

":
"{Integer}",
11
               "message
Message

Message of the notification definition.

":
"{String}",
12
               "translatedMessage
TranslatedMessage

The notification definition message in user language.

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

":
"{String}",
13
               "associatedCompanySettingDefintion
AssociatedCompanySettingDefintion

Company setting definition associated with the notification definiton. Through the company setting, you might be able to disable this kind of notifications.

":
{
14
                    "companySettingDefinitionId
CompanySettingDefinitionId

Company setting definition identifier

":
"{Integer}",
15
                    "companySettingDefinitionLink
CompanySettingDefinitionLink

Company setting definition reference

":
"{String}"
16
               },
17
               "notificationTypeLink
NotificationTypeLink

Notification type reference

":
"{String}"
18
          }
19
     ]
20
}

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: