Jump to

• Request
• Response

v1.0

post

/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subject-partial-dispensations

Retrieves visits marked with partial dispensation for all subjects

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:

  C36A3197FDEE433FB5547EE83DE99E4B

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : PartialDispensationSubjectsRequest v1.0

Type: object

Title: PartialDispensationSubjectsRequest v1.0

Contains a list of subjects to get partial dispensation details.

Show Source

• subjects(required): array Subjects
  Title: Subjects

  Minimum Number of Items: 1

  Maximum Number of Items: 2147483647

  List of subject IDs.

{
    "title":"PartialDispensationSubjectsRequest v1.0",
    "required":[
        "subjects"
    ],
    "type":"object",
    "properties":{
        "subjects":{
            "title":"Subjects",
            "maxItems":2147483647,
            "minItems":1,
            "type":"array",
            "description":"List of subject IDs.",
            "items":{
                "type":"string",
                "format":"uuid"
            }
        }
    },
    "description":"Contains a list of subjects to get partial dispensation details."
}

Nested Schema : Subjects

Type: array

Title: Subjects

Minimum Number of Items: 1

Maximum Number of Items: 2147483647

List of subject IDs.

Show Source

• Array of: string(uuid)

{
    "title":"Subjects",
    "maxItems":2147483647,
    "minItems":1,
    "type":"array",
    "description":"List of subject IDs.",
    "items":{
        "type":"string",
        "format":"uuid"
    }
}

Examples

Select an example Partial Dispensation Subjects Request

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : PartialDispensationSubjectsResponse v1.0

Type: object

Title: PartialDispensationSubjectsResponse v1.0

Response containing partial dispensation visits for subjects.

Show Source

• subjects: array Subjects
  Title: Subjects

  List of partial dispensation visits for subjects.

{
    "title":"PartialDispensationSubjectsResponse v1.0",
    "type":"object",
    "properties":{
        "subjects":{
            "title":"Subjects",
            "type":"array",
            "description":"List of partial dispensation visits for subjects.",
            "items":{
                "$ref":"#/components/schemas/PartialDispensationSubjectVisitsTO"
            }
        }
    },
    "description":"Response containing partial dispensation visits for subjects."
}

Nested Schema : Subjects

Type: array

Title: Subjects

List of partial dispensation visits for subjects.

Show Source

• Array of: object PartialDispensationSubjectVisitsTO v1.0
  Title: PartialDispensationSubjectVisitsTO v1.0

  Contains partial dispensation visits for a subject.

{
    "title":"Subjects",
    "type":"array",
    "description":"List of partial dispensation visits for subjects.",
    "items":{
        "$ref":"#/components/schemas/PartialDispensationSubjectVisitsTO"
    }
}

Nested Schema : PartialDispensationSubjectVisitsTO v1.0

Type: object

Title: PartialDispensationSubjectVisitsTO v1.0

Contains partial dispensation visits for a subject.

Show Source

• dispensationAllowed: boolean
  Title: Dispensation Allowed

  Indicates whether dispensation is allowed.

  Example: true
• instanceNumber: number (BigDecimal)
  Title: Instance Number

  Minimum Value: 1

  Visit instance number.

  Example: 2
• subjectId: string (uuid)
  Title: Subject ID

  Subject ID.
• visitDate: string (date-time)
  Title: Visit Date

  Visit date.
• visitId: string (uuid)
  Title: Visit ID

  Visit ID.

{
    "title":"PartialDispensationSubjectVisitsTO v1.0",
    "type":"object",
    "properties":{
        "subjectId":{
            "title":"Subject ID",
            "type":"string",
            "description":"Subject ID.",
            "format":"uuid"
        },
        "visitId":{
            "title":"Visit ID",
            "type":"string",
            "description":"Visit ID.",
            "format":"uuid"
        },
        "instanceNumber":{
            "title":"Instance Number",
            "minimum":1,
            "type":"number",
            "description":"Visit instance number.",
            "format":"BigDecimal",
            "example":2
        },
        "dispensationAllowed":{
            "title":"Dispensation Allowed",
            "type":"boolean",
            "description":"Indicates whether dispensation is allowed.",
            "example":true
        },
        "visitDate":{
            "title":"Visit Date",
            "type":"string",
            "description":"Visit date.",
            "format":"date-time"
        }
    },
    "description":"Contains partial dispensation visits for a subject."
}

Examples

Select an example Partial Dispensation Subjects Response

Back to Top