Jump to

• Request
• Response

V1.0

post

/ec-notifications-svc/rest/v1.0/i18support/email/{templatetype}

Sends email to users with the specified template. Provide support to internationalization in addition to list of study role IDs and email addresses.

Request

Path Parameters

• templatetype(required): string
  Name of the template to use to send email. Valid values are taken from email template configuration database, Allowed Values: CompletedTrainingTemplate, DefaultTrainingTemplate_L10n, CompletedTrainingTemplate_L10n, WithoutStudyTrainingTemplate, AssignedTrainingTemplate

  Example:

  DefaultTrainingTemplate_L10n

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Request body for sending localized email based on template with subject structure, recipients, placeholder maps, and optional direct email addresses and study role IDs.

Show Source

• emailAddresses: array emailAddresses
  Additional direct recipient email addresses
• placeHolderImageMap: object placeHolderImageMap
  Placeholder images map used by the template, mapping keys to image URLs or identifiers
• placeHolderValueMap: object PlaceHolderValueMap
  Container for placeholder properties used to build localized email content. Each property may define anchors for parameterized substitution.
• studyRoleIds: array studyRoleIds
  List of study role identifiers to target
• subject: object Subject
  Structured subject definition for i18n templates. Provides a message key and a collection of anchor values for substitution.
• users: array users
  List of recipient user email addresses

{
    "type":"object",
    "properties":{
        "subject":{
            "$ref":"#/components/schemas/Subject"
        },
        "users":{
            "type":"array",
            "description":"List of recipient user email addresses",
            "example":[
                "C5770247BEF54CE0923B7C7CA3B659C8",
                "DBF0480DD86446CE8482BE016726393C"
            ],
            "items":{
                "type":"string",
                "description":"List of recipient user email addresses",
                "example":"[\"C5770247BEF54CE0923B7C7CA3B659C8\",\"DBF0480DD86446CE8482BE016726393C\"]"
            }
        },
        "placeHolderValueMap":{
            "$ref":"#/components/schemas/PlaceHolderValueMap"
        },
        "placeHolderImageMap":{
            "type":"object",
            "description":"Placeholder images map used by the template, mapping keys to image URLs or identifiers",
            "example":{
                "logo":"https://cdn.example.com/assets/logo.png"
            }
        },
        "emailAddresses":{
            "type":"array",
            "description":"Additional direct recipient email addresses",
            "example":[
                "[e-mail]"
            ],
            "items":{
                "type":"string",
                "description":"Additional direct recipient email addresses",
                "example":"[\"[e-mail]\"]"
            }
        },
        "studyRoleIds":{
            "type":"array",
            "description":"List of study role identifiers to target",
            "example":[
                "1BC29B36F5D64B1B95F4BD765EA481BE"
            ],
            "items":{
                "type":"string",
                "description":"List of study role identifiers to target",
                "example":"[\"1BC29B36F5D64B1B95F4BD765EA481BE\"]"
            }
        }
    },
    "description":"Request body for sending localized email based on template with subject structure, recipients, placeholder maps, and optional direct email addresses and study role IDs."
}

Nested Schema : emailAddresses

Type: array

Additional direct recipient email addresses

Show Source

• Array of: string
  Additional direct recipient email addresses

  Example: ["[e-mail]"]

{
    "type":"array",
    "description":"Additional direct recipient email addresses",
    "example":[
        "[e-mail]"
    ],
    "items":{
        "type":"string",
        "description":"Additional direct recipient email addresses",
        "example":"[\"[e-mail]\"]"
    }
}

Example:

[
    "[e-mail]"
]

Nested Schema : placeHolderImageMap

Type: object

Placeholder images map used by the template, mapping keys to image URLs or identifiers

Example:

{
    "logo":"https://cdn.example.com/assets/logo.png"
}

Nested Schema : PlaceHolderValueMap

Type: object

Container for placeholder properties used to build localized email content. Each property may define anchors for parameterized substitution.

Show Source

• properties: array properties
  List of placeholder properties to substitute within the template body.

{
    "type":"object",
    "properties":{
        "properties":{
            "type":"array",
            "description":"List of placeholder properties to substitute within the template body.",
            "items":{
                "$ref":"#/components/schemas/Properties"
            }
        }
    },
    "description":"Container for placeholder properties used to build localized email content. Each property may define anchors for parameterized substitution."
}

Nested Schema : studyRoleIds

Type: array

List of study role identifiers to target

Show Source

• Array of: string
  List of study role identifiers to target

  Example: ["1BC29B36F5D64B1B95F4BD765EA481BE"]

{
    "type":"array",
    "description":"List of study role identifiers to target",
    "example":[
        "1BC29B36F5D64B1B95F4BD765EA481BE"
    ],
    "items":{
        "type":"string",
        "description":"List of study role identifiers to target",
        "example":"[\"1BC29B36F5D64B1B95F4BD765EA481BE\"]"
    }
}

Example:

[
    "1BC29B36F5D64B1B95F4BD765EA481BE"
]

Nested Schema : Subject

Type: object

Structured subject definition for i18n templates. Provides a message key and a collection of anchor values for substitution.

Show Source

• anchorKey: string
  Message key used to resolve the localized email subject text.

  Example: NTF_SIGN_OVERDUE
• anchorValues: object AnchorValues
  Container for key-value parameters that provide substitution values for a given anchor key.

{
    "type":"object",
    "properties":{
        "anchorKey":{
            "type":"string",
            "description":"Message key used to resolve the localized email subject text.",
            "example":"NTF_SIGN_OVERDUE"
        },
        "anchorValues":{
            "$ref":"#/components/schemas/AnchorValues"
        }
    },
    "description":"Structured subject definition for i18n templates. Provides a message key and a collection of anchor values for substitution."
}

Nested Schema : users

Type: array

List of recipient user email addresses

Show Source

• Array of: string
  List of recipient user email addresses

  Example: ["C5770247BEF54CE0923B7C7CA3B659C8","DBF0480DD86446CE8482BE016726393C"]

{
    "type":"array",
    "description":"List of recipient user email addresses",
    "example":[
        "C5770247BEF54CE0923B7C7CA3B659C8",
        "DBF0480DD86446CE8482BE016726393C"
    ],
    "items":{
        "type":"string",
        "description":"List of recipient user email addresses",
        "example":"[\"C5770247BEF54CE0923B7C7CA3B659C8\",\"DBF0480DD86446CE8482BE016726393C\"]"
    }
}

Example:

[
    "C5770247BEF54CE0923B7C7CA3B659C8",
    "DBF0480DD86446CE8482BE016726393C"
]

Nested Schema : properties

Type: array

List of placeholder properties to substitute within the template body.

Show Source

• Array of: object Properties
  Represents a single placeholder property in the template body, optionally including anchors for parameterized substitution.

{
    "type":"array",
    "description":"List of placeholder properties to substitute within the template body.",
    "items":{
        "$ref":"#/components/schemas/Properties"
    }
}

Nested Schema : Properties

Type: object

Represents a single placeholder property in the template body, optionally including anchors for parameterized substitution.

Show Source

• anchors: array anchors
  Anchors used to substitute dynamic portions within the property value
• propertyName: string
  Name of the placeholder property in the template body. Some examples: NTF_DCS_ADV_EVENT, NTF_SIGN_OVERDUE, NTF_HEADER_C1, NTF_HEADER_SITE_NAME, NTF_HEADER_STUDY_MODE, NTF_HEADER_STUDY_NAME etc

  Example: NTF_HEADER_SITE_NAME
• propertyValue: string
  Value of the placeholder property prior to anchor substitution. Some examples: NTF_DCS_ADV_EVENT, NTF_SIGN_OVERDUE, NTF_HEADER_C1, NTF_HEADER_SITE_NAME, NTF_HEADER_STUDY_MODE, NTF_HEADER_STUDY_NAME etc

  Example: NTF_HEADER_SITE_NAME

{
    "type":"object",
    "properties":{
        "propertyName":{
            "type":"string",
            "description":"Name of the placeholder property in the template body. Some examples: NTF_DCS_ADV_EVENT, NTF_SIGN_OVERDUE, NTF_HEADER_C1, NTF_HEADER_SITE_NAME, NTF_HEADER_STUDY_MODE, NTF_HEADER_STUDY_NAME etc",
            "example":"NTF_HEADER_SITE_NAME"
        },
        "propertyValue":{
            "type":"string",
            "description":"Value of the placeholder property prior to anchor substitution. Some examples: NTF_DCS_ADV_EVENT, NTF_SIGN_OVERDUE, NTF_HEADER_C1, NTF_HEADER_SITE_NAME, NTF_HEADER_STUDY_MODE, NTF_HEADER_STUDY_NAME etc ",
            "example":"NTF_HEADER_SITE_NAME"
        },
        "anchors":{
            "type":"array",
            "description":"Anchors used to substitute dynamic portions within the property value",
            "items":{
                "$ref":"#/components/schemas/Anchors"
            }
        }
    },
    "description":"Represents a single placeholder property in the template body, optionally including anchors for parameterized substitution."
}

Nested Schema : anchors

Type: array

Anchors used to substitute dynamic portions within the property value

Show Source

• Array of: object Anchors
  Anchor mapping used within template properties for text substitution. Associates an anchor key with its parameter values.

{
    "type":"array",
    "description":"Anchors used to substitute dynamic portions within the property value",
    "items":{
        "$ref":"#/components/schemas/Anchors"
    }
}

Nested Schema : Anchors

Type: object

Anchor mapping used within template properties for text substitution. Associates an anchor key with its parameter values.

Show Source

• anchorKey: string
  Unique subject anchor key within the export payload. Some examples: NTF_ORS_DEPOT_LOW_KIT, NTF_ORS_BODY_STUDY_NAME, NTF_ORS_BODY_STUDY_ID, NTF_ORS_BODY_STUDY_MODE, NTF_ORS_MODE_ACTIVE, NTF_ORS_MODE_TEST, NTF_ORS_MODE_TRAINING, NTF_ORS_NEW_SHIPMENT_DEPOT_ID, NTF_ORS_NEW_SHIPMENT_DEPOT_NAME, NTF_ORS_DEPOT_ADDRESS, NTF_ORS_DATE_ALERT_RAISED, NTF_ORS_KIT_TYPE_ID, NTF_ORS_KIT_TYPE_DESCRIPTION, NTF_ORS_CURRENT_INVENTORY_AVAILABLE.

  Example: NTF_SIGN_OVERDUE
• anchorValues: object AnchorValues
  Container for key-value parameters that provide substitution values for a given anchor key.

{
    "type":"object",
    "properties":{
        "anchorKey":{
            "type":"string",
            "description":"Unique subject anchor key within the export payload. Some examples: NTF_ORS_DEPOT_LOW_KIT, NTF_ORS_BODY_STUDY_NAME, NTF_ORS_BODY_STUDY_ID, NTF_ORS_BODY_STUDY_MODE, NTF_ORS_MODE_ACTIVE, NTF_ORS_MODE_TEST, NTF_ORS_MODE_TRAINING, NTF_ORS_NEW_SHIPMENT_DEPOT_ID, NTF_ORS_NEW_SHIPMENT_DEPOT_NAME, NTF_ORS_DEPOT_ADDRESS, NTF_ORS_DATE_ALERT_RAISED, NTF_ORS_KIT_TYPE_ID, NTF_ORS_KIT_TYPE_DESCRIPTION, NTF_ORS_CURRENT_INVENTORY_AVAILABLE.",
            "example":"NTF_SIGN_OVERDUE"
        },
        "anchorValues":{
            "$ref":"#/components/schemas/AnchorValues"
        }
    },
    "description":"Anchor mapping used within template properties for text substitution. Associates an anchor key with its parameter values."
}

Nested Schema : AnchorValues

Type: object

Container for key-value parameters that provide substitution values for a given anchor key.

Show Source

• keyValues: array keyValues
  List of key-value entries used to substitute placeholders for this anchor

{
    "type":"object",
    "properties":{
        "keyValues":{
            "type":"array",
            "description":"List of key-value entries used to substitute placeholders for this anchor",
            "items":{
                "$ref":"#/components/schemas/KeyValues"
            }
        }
    },
    "description":"Container for key-value parameters that provide substitution values for a given anchor key."
}

Nested Schema : keyValues

Type: array

List of key-value entries used to substitute placeholders for this anchor

Show Source

• Array of: object KeyValues
  Represents a single parameter for anchor substitution with an integer key, a value, and a type describing how to interpret the value.

{
    "type":"array",
    "description":"List of key-value entries used to substitute placeholders for this anchor",
    "items":{
        "$ref":"#/components/schemas/KeyValues"
    }
}

Nested Schema : KeyValues

Type: object

Represents a single parameter for anchor substitution with an integer key, a value, and a type describing how to interpret the value.

Show Source

• key: integer (int32)
  Integer key representing the position or identifier of the parameter in the anchor.

  Example: 0
• type: string
  Type of the value for rendering or validation. Typical values: TEXT, DATE.

  Example: TEXT
• value: string
  Parameter value to substitute.

  Example: ACTIVE

{
    "type":"object",
    "properties":{
        "key":{
            "type":"integer",
            "description":"Integer key representing the position or identifier of the parameter in the anchor.",
            "format":"int32",
            "example":0
        },
        "value":{
            "type":"string",
            "description":"Parameter value to substitute.",
            "example":"ACTIVE"
        },
        "type":{
            "type":"string",
            "description":"Type of the value for rendering or validation. Typical values: TEXT, DATE.",
            "example":"TEXT"
        }
    },
    "description":"Represents a single parameter for anchor substitution with an integer key, a value, and a type describing how to interpret the value."
}

Examples

Select an example EmailTemplateNotificationDto

Back to Top

Response

Supported Media Types

• application/json

202 Response

Request processed successfully, check the result

400 Response

Error in request, check the request

Body ()

Root Schema : NotificationResponse

Type: object

Standard wrapper for API responses. Contains the request processing status, the result payload for successful requests, and error details when a request fails.

Show Source

• errorData: object Error Response
  Read Only: true

  Standard error body containing code, message and optional details.
• result: object result
  Read Only: true

  Result payload for the request. The concrete type depends on the endpoint and is described in the corresponding API documentation.
• status: string
  Read Only: true

  Allowed Values: [ "success, Failed" ]

  Status of the request processing. SUCCESS indicates the request was processed without errors. Any other value indicates failure.

  Example: success

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of the request processing. SUCCESS indicates the request was processed without errors. Any other value indicates failure.",
            "readOnly":true,
            "example":"success",
            "enum":[
                "success, Failed"
            ]
        },
        "result":{
            "type":"object",
            "description":"Result payload for the request. The concrete type depends on the endpoint and is described in the corresponding API documentation.",
            "readOnly":true
        },
        "errorData":{
            "$ref":"#/components/schemas/Error Response"
        }
    },
    "description":"Standard wrapper for API responses. Contains the request processing status, the result payload for successful requests, and error details when a request fails."
}

Nested Schema : Error Response

Type: object

Read Only: true

Standard error body containing code, message and optional details.

Show Source

• details: object details
  Read Only: true

  Optional additional details about the error for diagnostics.
• errorCode: string
  Read Only: true

  Application-specific error code representing the failure reason.

  Example: VALIDATION_ERROR
• errorMessage: string
  Read Only: true

  Human-readable message describing the error.

  Example: Request payload validation failed

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application-specific error code representing the failure reason.",
            "readOnly":true,
            "example":"VALIDATION_ERROR"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable message describing the error.",
            "readOnly":true,
            "example":"Request payload validation failed"
        },
        "details":{
            "type":"object",
            "description":"Optional additional details about the error for diagnostics.",
            "nullable":true,
            "readOnly":true
        }
    },
    "description":"Standard error body containing code, message and optional details.",
    "nullable":true,
    "readOnly":true
}

Nested Schema : result

Type: object

Read Only: true

Result payload for the request. The concrete type depends on the endpoint and is described in the corresponding API documentation.

Nested Schema : details

Type: object

Read Only: true

Optional additional details about the error for diagnostics.

Examples

Select an example NotificationResponse

Back to Top