Jump to

• Request
• Response

v3.0

get

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

Checks if subject is eligible for titration. This is a new version of the API for returning additional attributes for titration kit label. Rights: OrsSubjectVisitGet.

Request

Path Parameters

• mode(required): string
  Indicates the operational mode of the study. Accepted values: active, test, or training.

  Example:

  test

• studyId(required): string(uuid)
  Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example:

  1BC29B36F5D64B1B95F4BDBBCEA481BE

• subjectId(required): string(uuid)
  Unique identifier of the subject. Used to represent a participant enrolled in a study. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example:

  11111111111111112000000000000000

Query Parameters

• instanceNumber: string
  Instance number for unscheduled visit.

  Example:

  1

• studyVersion(required): string
  String representing the version of the study. Helps track changes in form or study design.

  Example:

  1

• visitId(required): string(uuid)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) of the visit

  Example:

  9B83BFB48C5A41C59775E4D8D22D8B26

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
  Indicates whether down titration is allowed.

  Example: true
• isUpAllowed(required): boolean
  Indicates whether up titration is allowed.

  Example: true
• kitsDispensed(required): array Kits Dispensed
  Title: Kits Dispensed

  IDs of kits dispensed.
• status(required): string
  Status of titration allowed.

  Example: ALLOW
• 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"
        },
        "isUpAllowed":{
            "type":"boolean",
            "description":"Indicates whether up titration is allowed.",
            "example":true
        },
        "isDownAllowed":{
            "type":"boolean",
            "description":"Indicates whether down titration is allowed.",
            "example":true
        },
        "kitsDispensed":{
            "title":"Kits Dispensed",
            "type":"array",
            "description":"IDs of kits dispensed.",
            "example":[
                "B1B8327AFAA6412287106192AB5984EF",
                "C36A3197FDEE433FB5547EE83DE99E4B"
            ],
            "items":{
                "type":"string",
                "format":"uuid"
            }
        }
    }
}

Nested Schema : Kits Dispensed

Type: array

Title: Kits Dispensed

IDs of kits dispensed.

Show Source

• Array of: string(uuid)

{
    "title":"Kits Dispensed",
    "type":"array",
    "description":"IDs of kits dispensed.",
    "example":[
        "B1B8327AFAA6412287106192AB5984EF",
        "C36A3197FDEE433FB5547EE83DE99E4B"
    ],
    "items":{
        "type":"string",
        "format":"uuid"
    }
}

Example:

[
    "B1B8327AFAA6412287106192AB5984EF",
    "C36A3197FDEE433FB5547EE83DE99E4B"
]

Examples

Select an example Titration Eligible Response

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
  Title: ErrorResponseData

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

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

Result Object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Examples

Select an example Titration Eligible Bad Request Response

404 Response

Visit not found.

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
  Title: ErrorResponseData

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

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

Result Object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Examples

Select an example Titration Eligible Not Found Response

500 Response

Internal server error

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
  Title: ErrorResponseData

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

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

Result Object

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Examples

Select an example Titration Eligible Server Error Response

Back to Top