Jump to

• Request
• Response

Sign subject and visits

post

/ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/studyVersion/{studyVersion}/signSubject/subject/{subjectId}/code/{code}/orgId/{orgId}

Signs a subject and all completed visits in the subject. Repeating sections supported. Rights: DataCaptureSubjectPost and SubjectDataClassificationPost.

Request

Path Parameters

• code(required): string
  Code is sent via IAMS as initial sign
• mode(required): string
  Mode of the study. Accepts test, active, or training.
• orgId(required): string
  IAMS Tenant Short Org ID
• studyId(required): string
  ID of the study to which the subject belongs.
• studyVersion(required): string
  Study version associated to subject's site.
• subjectId(required): string
  ID of the current subject to sign.

Query Parameters

• redirectUriHostname: string
  Redirect URI

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• signRequest: array signRequest

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

Nested Schema : signRequest

Type: array

Show Source

• Array of: object SignDTO

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

Nested Schema : SignDTO

Type: object

Show Source

• configId: string (uuid)
• eventId: string (uuid)
• eventInstanceNum: integer
• formId: string (uuid)
• innerRepeat: integer
• outerRepeat: integer
• signLevel: string

{
    "type":"object",
    "properties":{
        "signLevel":{
            "type":"string"
        },
        "eventId":{
            "type":"string",
            "format":"uuid"
        },
        "eventInstanceNum":{
            "type":"integer"
        },
        "configId":{
            "type":"string",
            "format":"uuid"
        },
        "innerRepeat":{
            "type":"integer"
        },
        "outerRepeat":{
            "type":"integer"
        },
        "formId":{
            "type":"string",
            "format":"uuid"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Subjects sign success

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object SignVerifyFreezeDTOv30

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

Nested Schema : SignVerifyFreezeDTOv30

Type: object

Show Source

• comment: string
  Minimum Length: 0

  Maximum Length: 2048
• eventId: string
• eventInstanceNum: integer
• formId: string
• formSectionId: string
• freeze: string
• id: string (uuid)
• itemId: string
• objectVersionNumber: number
• operationType: string
• reason: string
  Minimum Length: 0

  Maximum Length: 255
• repeatFormNumber: integer
• repeatSequenceNumber: integer
• signed: string
• softwareVersionNumber: number
• studyVersion: string
• subjectId: string
• userId: string (uuid)
• verify: string
• versionEnd: string (date-time)
• versionStart: string (date-time)

{
    "type":"object",
    "properties":{
        "formSectionId":{
            "type":"string"
        },
        "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":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "comment":{
            "maxLength":"2048",
            "minLength":"0",
            "type":"string"
        },
        "formId":{
            "type":"string"
        },
        "subjectId":{
            "type":"string"
        },
        "eventId":{
            "type":"string"
        },
        "repeatSequenceNumber":{
            "type":"integer"
        },
        "itemId":{
            "type":"string"
        },
        "signed":{
            "type":"string"
        },
        "verify":{
            "type":"string"
        },
        "freeze":{
            "type":"string"
        },
        "studyVersion":{
            "type":"string"
        },
        "eventInstanceNum":{
            "type":"integer"
        },
        "repeatFormNumber":{
            "type":"integer"
        }
    }
}

400 Response

Bad request.

Body ()

Root Schema : DcsResponse

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