Jump to

• Request
• Response

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

Request Body - 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

• canBeCompleted: boolean
• canBeReplaced: boolean
• canBeUndoWithdrawn: boolean
• codeBreak: string
• comment: string
  Minimum Length: 0

  Maximum Length: 2048
• description: string
  Minimum Length: 0

  Maximum Length: 500
• dob: string (date-time)
• enrollmentFailure: string
  Minimum Length: 0

  Maximum Length: 255
• enrollmentOverride: string
  Minimum Length: 0

  Maximum Length: 255
• freezedStatus: string
• fromStudyId: string (uuid)
• gender: string
  Minimum Length: 0

  Maximum Length: 10
• hasLockData: boolean
• id: string (uuid)
• informedConsentDate: string (date-time)
• lastSigned: string
• lockedDateTime: string (date-time)
• lockedInStudyVersion: string
• lockedStatus: string
• mhealthSubjectId: string (uuid)
• operationType: string
  Minimum Length: 1

  Maximum Length: 16
• previousSubjectNumber: string
• randomizationNumber: string
• reason: string
  Minimum Length: 0

  Maximum Length: 255
• replaceRand: string
• screenFailureComment: string
• screenFailureDate: string (date-time)
• screeningDate: string (date-time)
• screeningFailure: string
  Minimum Length: 0

  Maximum Length: 255
• sdvSelectionStatus: string
• signedStatus: string
• siteId: string
• sourceTimeStamp: string (date-time)
• state(required): string
  Minimum Length: 0

  Maximum Length: 100
• stateDate: string (date-time)
• studyCompletionDate: string (date-time)
• studyId: string
• studyVersion: string
• subjectNumber(required): string
  Minimum Length: 0

  Maximum Length: 500
• subjectSDVUpdated: boolean
• subjNumSiteOrgId: string
• unblindComment: string
• unblindDate: string (date-time)
• unblindReason: string
• userId: string (uuid)
• verifiedStatus: string
• versionStart: string (date-time)
• withdrawalComment: string
• withdrawalDate: string (date-time)
• withdrawalReason: string

{
    "required":[
        "state",
        "subjectNumber"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string"
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string"
        },
        "operationType":{
            "maxLength":16,
            "minLength":1,
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "description":{
            "maxLength":500,
            "minLength":0,
            "type":"string"
        },
        "subjectNumber":{
            "maxLength":500,
            "minLength":0,
            "type":"string"
        },
        "studyId":{
            "type":"string"
        },
        "siteId":{
            "type":"string"
        },
        "dob":{
            "type":"string",
            "format":"date-time"
        },
        "screeningDate":{
            "type":"string",
            "format":"date-time"
        },
        "state":{
            "maxLength":100,
            "minLength":0,
            "type":"string"
        },
        "stateDate":{
            "type":"string",
            "format":"date-time"
        },
        "sourceTimeStamp":{
            "type":"string",
            "format":"date-time"
        },
        "screeningFailure":{
            "maxLength":255,
            "minLength":0,
            "type":"string"
        },
        "enrollmentFailure":{
            "maxLength":255,
            "minLength":0,
            "type":"string"
        },
        "enrollmentOverride":{
            "maxLength":255,
            "minLength":0,
            "type":"string"
        },
        "informedConsentDate":{
            "type":"string",
            "format":"date-time"
        },
        "gender":{
            "maxLength":10,
            "minLength":0,
            "type":"string"
        },
        "studyVersion":{
            "type":"string"
        },
        "codeBreak":{
            "type":"string"
        },
        "mhealthSubjectId":{
            "type":"string",
            "format":"uuid"
        },
        "fromStudyId":{
            "type":"string",
            "format":"uuid"
        },
        "subjNumSiteOrgId":{
            "type":"string"
        },
        "sdvSelectionStatus":{
            "type":"string"
        },
        "withdrawalDate":{
            "type":"string",
            "format":"date-time"
        },
        "studyCompletionDate":{
            "type":"string",
            "format":"date-time"
        },
        "unblindDate":{
            "type":"string",
            "format":"date-time"
        },
        "unblindReason":{
            "type":"string"
        },
        "unblindComment":{
            "type":"string"
        },
        "withdrawalReason":{
            "type":"string"
        },
        "withdrawalComment":{
            "type":"string"
        },
        "screenFailureComment":{
            "type":"string"
        },
        "replaceRand":{
            "type":"string"
        },
        "signedStatus":{
            "type":"string"
        },
        "canBeCompleted":{
            "type":"boolean"
        },
        "canBeReplaced":{
            "type":"boolean"
        },
        "canBeUndoWithdrawn":{
            "type":"boolean"
        },
        "previousSubjectNumber":{
            "type":"string"
        },
        "subjectSDVUpdated":{
            "type":"boolean"
        },
        "randomizationNumber":{
            "type":"string"
        },
        "screenFailureDate":{
            "type":"string",
            "format":"date-time"
        },
        "verifiedStatus":{
            "type":"string"
        },
        "freezedStatus":{
            "type":"string"
        },
        "lastSigned":{
            "type":"string"
        },
        "lockedStatus":{
            "type":"string"
        },
        "hasLockData":{
            "type":"boolean"
        },
        "lockedDateTime":{
            "type":"string",
            "format":"date-time"
        },
        "lockedInStudyVersion":{
            "type":"string"
        }
    }
}

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"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success.

400 Response

Bad request.

Body ()

Root Schema : NotificationResponse

Type: object

Show Source

• errorData: object ErrorResponseData
• result: object result
• status: string

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

Nested Schema : ErrorResponseData

Type: object

Show Source

• details: object details
• errorCode: string
• errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : result

Type: object

Nested Schema : details

Type: object

500 Response

Internal server error.

Body ()

Root Schema : NotificationResponse

Type: object

Show Source

• errorData: object ErrorResponseData
• result: object result
• status: string

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

Nested Schema : ErrorResponseData

Type: object

Show Source

• details: object details
• errorCode: string
• errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : result

Type: object

Nested Schema : details

Type: object

Back to Top