Jump to

• Request
• Response

[Deprecated]: V1.0

post

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

Deprecated: Signs a subject and all completed visits in the subject.

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 in format of UUID, 32-character uppercase hexadecimal string
• 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

There's no request body for this operation.

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 SignVerifyDto v1
  Title: SignVerifyDto v1

  sign or verify request

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

Nested Schema : SignVerifyDto v1

Type: object

Title: SignVerifyDto v1

sign or verify request

Show Source

• eventId: string
• eventInstanceNum: integer
• formId: string
• itemId: string
• repeatSequenceNumber: integer
• signed: string
• studyVersion(required): string
  Minimum Length: 1

  Maximum Length: 64
• subjectId: string
• verify: string

{
    "title":"SignVerifyDto v1",
    "required":[
        "studyVersion"
    ],
    "type":"object",
    "properties":{
        "subjectId":{
            "type":"string"
        },
        "eventId":{
            "type":"string"
        },
        "formId":{
            "type":"string"
        },
        "signed":{
            "type":"string"
        },
        "verify":{
            "type":"string"
        },
        "repeatSequenceNumber":{
            "type":"integer"
        },
        "itemId":{
            "type":"string"
        },
        "eventInstanceNum":{
            "type":"integer"
        },
        "studyVersion":{
            "maxLength":64,
            "minLength":1,
            "type":"string"
        }
    },
    "description":"sign or verify request"
}

400 Response

Bad request.

Body ()

Root Schema : DcsResponse

Type: object

Show Source

• errorData: object ErrorResponseData
  Title: ErrorResponseData

  Error Response Details Information
• 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

Title: ErrorResponseData

Error Response Details Information

Show Source

• details: object Object
  Title: Object

  Object with error details information.
• errorCode: string
  Error code which is stored in ErrorCode enum. Example : C1-003

  Example: C1-003
• errorMessage: string
  Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

  Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : result

Type: object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Back to Top