Jump to

• Request
• Response

Register mHealth device

post

/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/{subjectId}/register-device

Registers an mHealth device. Rights: DeviceActionsPost.

Request

Path Parameters

• mode(required): string
  Mode of the study, accepts: test, active, or training
• studyId(required): string(uuid)
  ID of the study
• subjectId(required): string(uuid)
  ID of the subject

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Request object containing mHealth device registration details.

Show Source

• inventoryId(required): string (uuid)
  ID of the inventory.
• mSubjectId(required): string
  ID of the subject in mHealth

  Example: B1B8327AFAA6412287106192AB5984EF
• subjectNumber: string
  Minimum Length: 0

  Maximum Length: 100

  Subject number

  Example: siteA-1
• vendorCode: string
  Minimum Length: 0

  Maximum Length: 100

  Vendor code of the cloud to cloud connection type device.

  Example: XYZ123

{
    "required":[
        "inventoryId",
        "mSubjectId"
    ],
    "type":"object",
    "properties":{
        "vendorCode":{
            "maxLength":"100",
            "minLength":"0",
            "type":"string",
            "description":"Vendor code of the cloud to cloud connection type device.",
            "example":"XYZ123"
        },
        "inventoryId":{
            "type":"string",
            "description":"ID of the inventory.",
            "format":"uuid"
        },
        "mSubjectId":{
            "type":"string",
            "description":"ID of the subject in mHealth",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "subjectNumber":{
            "maxLength":"100",
            "minLength":"0",
            "type":"string",
            "description":"Subject number",
            "example":"siteA-1"
        }
    },
    "description":"Request object containing mHealth device registration details."
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : BootStrapCredResponseDto

Type: object

Contains details about bootstrap device.

Show Source

• accessId: string
  Client access code generated for a bootstrap device.

  Example: ABC123
• id: string
  Device instance identifier.

  Example: B1B8327AFAA6412287106192AB5984EF
• otp: string
  Time-sensitive, one-time authorization code generated by the mHealth Connector Cloud application to bootstrap a device.

  Example: ABCD1234

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Device instance identifier.",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "accessId":{
            "type":"string",
            "description":"Client access code generated for a bootstrap device.",
            "example":"ABC123"
        },
        "otp":{
            "type":"string",
            "description":"Time-sensitive, one-time authorization code generated by the mHealth Connector Cloud application to bootstrap a device.",
            "example":"ABCD1234"
        }
    },
    "description":"Contains details about bootstrap device."
}

400 Response

Invalid subject Id OR Device is not dispensed to the subject OR Device is dispensed to different subject OR Invalid device Id OR Cloud to cloud connection type device is already registered OR Device does not have a connection type OR Vendor code is missing for cloud to cloud connection type of devices OR Vendor code has been specified for device to cloud connection type of devices OR Subject number is missing for device to cloud connection type of devices OR Device is of no-connection connection type

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
• result: object result
  Result Object
• status: string
  Status of request

  Example: Success
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of request",
            "example":"Success"
        },
        "result":{
            "type":"object",
            "description":"Result Object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Common response object."
}

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

Result Object

Nested Schema : details

Type: object

404 Response

Invalid study ID or version

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
• result: object result
  Result Object
• status: string
  Status of request

  Example: Success
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of request",
            "example":"Success"
        },
        "result":{
            "type":"object",
            "description":"Result Object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Common response object."
}

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

Result Object

Nested Schema : details

Type: object

500 Response

Internal server error OR mHealth setttings are not found.

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
• result: object result
  Result Object
• status: string
  Status of request

  Example: Success
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of request",
            "example":"Success"
        },
        "result":{
            "type":"object",
            "description":"Result Object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Common response object."
}

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

Result Object

Nested Schema : details

Type: object

Back to Top