Jump to

• Request
• Response

Register subject to mHealth

post

/ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/mhealthRegister

Registers subject to mHealth.

Request

Path Parameters

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

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• mhealthSubjectId: string (uuid)
• subjectId: string (uuid)

{
    "type":"object",
    "properties":{
        "mhealthSubjectId":{
            "type":"string",
            "format":"uuid"
        },
        "subjectId":{
            "type":"string",
            "format":"uuid"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Subjects success.

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

400 Response

Bad request.

Body ()

Root Schema : schema

Type: object

Show Source

• mhealthSubjectId: string (uuid)
• subjectId: string (uuid)

{
    "type":"object",
    "properties":{
        "mhealthSubjectId":{
            "type":"string",
            "format":"uuid"
        },
        "subjectId":{
            "type":"string",
            "format":"uuid"
        }
    }
}

Back to Top