Jump to

• Request
• Response

Get sign information

get

/ec-dataction-svc/rest/v1.0/studies/{studyId}/{mode}/signinfo

Retrieves sign information by study ID and mode.

Request

Path Parameters

• mode(required): string
  Mode to fetch the record for
• studyId(required): string
  ID of the study for which you want to get the list of subjects.

Query Parameters

• eventId: string
  Event ID to fetch the record for
• eventInstanceNum: integer
  Event Instance Number to fetch the record for
• limit: integer(int32)
  number of records
• offset: integer(int32)
  starting offset
• signStatus: string
  Sign status to fetch the record for
• siteIds: array[string]
  Site IDs to fetch the record for
• subjectId: string
  Subject ID to fetch the record for

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 SignConfigEligibilityResponseDTO

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

Nested Schema : SignConfigEligibilityResponseDTO

Type: object

Show Source

• actionStatus: string
• affidavitCodeValue: string
• comment: string
• configId: string (uuid)
• dueDays: integer
• eventId: string (uuid)
• eventInstanceNum: integer
• formId: string (uuid)
• formSectionId: string (uuid)
• formTitle: string
• id: string (uuid)
• innerRepeat: integer
• objectVersionNumber: number
• operationType: string
• outerRepeat: integer
• reason: string
• repeatFormNumber: integer
• repeatSequenceNumber: integer
• requiredBy: array requiredBy
• requiredOn: string
• siteId: string (uuid)
• softwareVersionNumber: number
• status: string
• studyVersion: string
• subjectId: string (uuid)
• subjectNumber: string
• userId: string (uuid)
• versionEnd: string (date-time)
• versionStart: string (date-time)
• visitTitle: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "operationType":{
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "reason":{
            "type":"string"
        },
        "comment":{
            "type":"string"
        },
        "configId":{
            "type":"string",
            "format":"uuid"
        },
        "requiredOn":{
            "type":"string"
        },
        "affidavitCodeValue":{
            "type":"string"
        },
        "requiredBy":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "siteId":{
            "type":"string",
            "format":"uuid"
        },
        "subjectId":{
            "type":"string",
            "format":"uuid"
        },
        "subjectNumber":{
            "type":"string"
        },
        "eventId":{
            "type":"string",
            "format":"uuid"
        },
        "eventInstanceNum":{
            "type":"integer"
        },
        "formId":{
            "type":"string",
            "format":"uuid"
        },
        "repeatSequenceNumber":{
            "type":"integer"
        },
        "repeatFormNumber":{
            "type":"integer"
        },
        "innerRepeat":{
            "type":"integer"
        },
        "outerRepeat":{
            "type":"integer"
        },
        "formSectionId":{
            "type":"string",
            "format":"uuid"
        },
        "status":{
            "type":"string"
        },
        "studyVersion":{
            "type":"string"
        },
        "actionStatus":{
            "type":"string"
        },
        "dueDays":{
            "type":"integer"
        },
        "formTitle":{
            "type":"string"
        },
        "visitTitle":{
            "type":"string"
        }
    }
}

Nested Schema : requiredBy

Type: array

Show Source

• Array of: string

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

400 Response

Bad_Request

Body ()

Root Schema : RestResponse

Type: object

Show Source

• errorData: object ErrorResponseData
• result: object result
• status: string
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "result":{
            "type":"object"
        },
        "version":{
            "type":"integer",
            "format":"int32",
            "writeOnly":true
        },
        "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