REST API for Clinical One Platform

Use a template to send email to a user with internationalization support

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. The template is stored in the configuration PDB.

Request

Path Parameters

templatetype(required): string

Name of template to use to send email. Valid values are taken from email template configuration database.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

emailAddresses: array emailAddresses
placeHolderImageMap: object placeHolderImageMap

Additional Properties Allowed: additionalProperties
placeHolderValueMap: object PlaceHolderValueMap
studyRoleIds: array studyRoleIds
subject: object Subject
users: array users

{
    "type":"object",
    "properties":{
        "subject":{
            "$ref":"#/components/schemas/Subject"
        },
        "users":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "placeHolderValueMap":{
            "$ref":"#/components/schemas/PlaceHolderValueMap"
        },
        "placeHolderImageMap":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "emailAddresses":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "studyRoleIds":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : emailAddresses

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : placeHolderImageMap

Type: object

Additional Properties Allowed

Show Source

string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : PlaceHolderValueMap

Type: object

Show Source

properties: array properties

{
    "type":"object",
    "properties":{
        "properties":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Properties"
            }
        }
    }
}

Nested Schema : studyRoleIds

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : Subject

Type: object

Show Source

anchorKey: string
anchorValues: object AnchorValues

{
    "type":"object",
    "properties":{
        "anchorKey":{
            "type":"string"
        },
        "anchorValues":{
            "$ref":"#/components/schemas/AnchorValues"
        }
    }
}

Nested Schema : users

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : properties

Type: array

Show Source

Array of: object Properties

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Properties"
    }
}

Nested Schema : Properties

Type: object

Show Source

anchors: array anchors
propertyName: string
propertyValue: string

{
    "type":"object",
    "properties":{
        "propertyName":{
            "type":"string"
        },
        "propertyValue":{
            "type":"string"
        },
        "anchors":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Anchors"
            }
        }
    }
}

Nested Schema : anchors

Type: array

Show Source

Array of: object Anchors

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Anchors"
    }
}

Nested Schema : Anchors

Type: object

Show Source

anchorKey: string
anchorValues: object AnchorValues

{
    "type":"object",
    "properties":{
        "anchorKey":{
            "type":"string"
        },
        "anchorValues":{
            "$ref":"#/components/schemas/AnchorValues"
        }
    }
}

Nested Schema : AnchorValues

Type: object

Show Source

keyValues: array keyValues

{
    "type":"object",
    "properties":{
        "keyValues":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/KeyValues"
            }
        }
    }
}

Nested Schema : keyValues

Type: array

Show Source

Array of: object KeyValues

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/KeyValues"
    }
}

Nested Schema : KeyValues

Type: object

Show Source

key: integer (int32)
type: string
value: string

{
    "type":"object",
    "properties":{
        "key":{
            "type":"integer",
            "format":"int32"
        },
        "value":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Success.

400 Response

Bad request.

Root Schema : NotificationResponse

Type: object

Show Source

errorData: object ErrorResponseData

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
result: object result
status: string

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "result":{
            "type":"object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    }
}

Nested Schema : ErrorResponseData

Type: object

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

details: string

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

Example: User role is missing required permission REPORTING_VIEW. Field: userId
errorCode: string

Application or business-specific error code representing the error type.

Example: REPT_401
errorMessage: string

Human-readable error message describing the failure or issue.

Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"string",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

Nested Schema : result

Type: object

500 Response

Internal server error.

Root Schema : NotificationResponse

Type: object

Show Source

errorData: object ErrorResponseData

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
result: object result
status: string

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "result":{
            "type":"object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    }
}

Nested Schema : ErrorResponseData

Type: object

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

details: string

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

Example: User role is missing required permission REPORTING_VIEW. Field: userId
errorCode: string

Application or business-specific error code representing the error type.

Example: REPT_401
errorMessage: string

Human-readable error message describing the failure or issue.

Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"string",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

Nested Schema : result

Type: object