Jump to

• Request
• Response

[Deprecated]: Check if subject is eligible for titration

get

/ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/{subjectId}/titration-eligible

Deprecated: Use latest version instead. To check if Subject is eligible for titration. Rights: OrsSubjectVisitGet.

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

Query Parameters

• instanceNumber: string
  Instance number for unscheduled visit.
• studyVersion(required): string
  Version of the study
• visitId(required): string(uuid)
  ID of the visit

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object SubjectVisitKitTypeTO

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

Nested Schema : SubjectVisitKitTypeTO

Type: object

Show Source

• isDownAllowed(required): boolean
  Is down titration allowed

  Example: true
• isUpAllowed(required): boolean
  Is up titration allowed

  Example: true
• kitsDispensed(required): array kitsDispensed
  Id's of kits dispensed
• status(required): string
  Status of titration allowed

  Example: ALLOW, COOL_DOWN_PERIOD, MAX_CHANGES_DONE, NOT_ALLOWED_ON_THE_VISIT
• titrationId(required): string (uuid)
  ID of the titration
• titrationKitLabel: string
  Label of the matching titration row

  Example: Low Dose

{
    "required":[
        "isDownAllowed",
        "isUpAllowed",
        "kitsDispensed",
        "status",
        "titrationId"
    ],
    "type":"object",
    "properties":{
        "titrationKitLabel":{
            "type":"string",
            "description":"Label of the matching titration row",
            "example":"Low Dose"
        },
        "titrationId":{
            "type":"string",
            "description":"ID of the titration",
            "format":"uuid"
        },
        "status":{
            "type":"string",
            "description":"Status of titration allowed",
            "example":"ALLOW, COOL_DOWN_PERIOD, MAX_CHANGES_DONE, NOT_ALLOWED_ON_THE_VISIT"
        },
        "isUpAllowed":{
            "type":"boolean",
            "description":"Is up titration allowed",
            "example":true
        },
        "isDownAllowed":{
            "type":"boolean",
            "description":"Is down titration allowed",
            "example":true
        },
        "kitsDispensed":{
            "type":"array",
            "description":"Id's of kits dispensed",
            "items":{
                "type":"string",
                "description":"Id's of kits dispensed",
                "format":"uuid"
            }
        }
    }
}

Nested Schema : kitsDispensed

Type: array

Id's of kits dispensed

Show Source

• Array of: string(uuid)
  Id's of kits dispensed

{
    "type":"array",
    "description":"Id's of kits dispensed",
    "items":{
        "type":"string",
        "description":"Id's of kits dispensed",
        "format":"uuid"
    }
}

400 Response

For a subject who cannot be titrated as there are no titration kits dispensed to the subject earlier OR Subject cannot be titrated as no matching kits are defined with subject dispensations. ORInvalid subject OR Missing subject OR Scheduled visit with instance number OR Unscheduled visit with no instance number

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

Visit 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

500 Response

Internal server error

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