Jump to

• Request
• Response

View a user's inbox

get

/ec-notifications-svc/rest/v1.0/studies/{studyId}/{mode}/notificationsbroadcast

Gets a user's inbox, a list of notifications for the user.

Request

Path Parameters

• mode(required): string
  Mode of the study. Accepts active, test, or training.
• studyId(required): string
  ID of the study.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object NotificationsDetailResponse

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

Nested Schema : NotificationsDetailResponse

Type: object

Show Source

• entityId: string (uuid)
• entityType: string
• messageDescription: string
• messageSubject: string
• notificationsBroadcast: object NotificationsBroadcast

{
    "type":"object",
    "properties":{
        "messageDescription":{
            "type":"string"
        },
        "messageSubject":{
            "type":"string"
        },
        "entityId":{
            "type":"string",
            "format":"uuid"
        },
        "entityType":{
            "type":"string"
        },
        "notificationsBroadcast":{
            "$ref":"#/components/schemas/NotificationsBroadcast"
        }
    }
}

Nested Schema : NotificationsBroadcast

Type: object

Show Source

• actionId: string (uuid)
• approvalFlag: string
• archiveDateTime(required): string
• category: string
• comment: string
• emailAttemptDateTime: string (date-time)
• id: string (uuid)
• messageReadDateTime(required): string
• notificationDateTime: string
• notificationLogId: string (uuid)
• objectVersionNumber: number
• operationType: string
• reason: string
• softwareVersionNumber: number
• subscription: string
• updatedBy: string (uuid)
• userEmailAddress: string
• userId: string (uuid)
• userName: string
• versionEnd: string (date-time)
• versionStart: string (date-time)

{
    "required":[
        "archiveDateTime",
        "messageReadDateTime"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "notificationLogId":{
            "type":"string",
            "format":"uuid"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "userName":{
            "type":"string"
        },
        "userEmailAddress":{
            "type":"string"
        },
        "subscription":{
            "type":"string"
        },
        "messageReadDateTime":{
            "type":"string"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "operationType":{
            "type":"string"
        },
        "reason":{
            "type":"string"
        },
        "archiveDateTime":{
            "type":"string"
        },
        "category":{
            "type":"string"
        },
        "emailAttemptDateTime":{
            "type":"string",
            "format":"date-time"
        },
        "updatedBy":{
            "type":"string",
            "format":"uuid"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "approvalFlag":{
            "type":"string"
        },
        "notificationDateTime":{
            "type":"string"
        },
        "comment":{
            "type":"string"
        },
        "actionId":{
            "type":"string",
            "format":"uuid"
        },
        "objectVersionNumber":{
            "type":"number"
        }
    }
}

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

Back to Top