Jump to

• Request
• Response

[Deprecated]: v2.0

get

/ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/visits/subjectvisit

Deprecated: Use latest version instead. Retrieves a visit by its visit ID. 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:

  C36A3197FDEE433FB5547EE83DE99E4B

Query Parameters

• externalSubjectId: string
• visitId: string

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : VisitResult

Type: object

Title: VisitResult

Visit result.

Show Source

• kits: array Kits
  Title: Kits

  Contains information for the kit dispensation.
• randomNumber: string
  Title: Random Number

  Random number.
• treatmentTitle: string
  Title: Treatment Title

  Treatment title.
• visitTimestamp: string (date-time)
  Title: Visit Timestamp

  Visit timestamp.

{
    "title":"VisitResult",
    "type":"object",
    "properties":{
        "randomNumber":{
            "title":"Random Number",
            "type":"string",
            "description":"Random number."
        },
        "kits":{
            "title":"Kits",
            "type":"array",
            "description":"Contains information for the kit dispensation.",
            "items":{
                "$ref":"#/components/schemas/DispensationKitV2"
            }
        },
        "visitTimestamp":{
            "title":"Visit Timestamp",
            "type":"string",
            "description":"Visit timestamp.",
            "format":"date-time"
        },
        "treatmentTitle":{
            "title":"Treatment Title",
            "type":"string",
            "description":"Treatment title."
        }
    },
    "description":"Visit result."
}

Nested Schema : Kits

Type: array

Title: Kits

Contains information for the kit dispensation.

Show Source

• Array of: object DispensationKit v2.0
  Title: DispensationKit v2.0

  Contains information for the kit dispensation.

{
    "title":"Kits",
    "type":"array",
    "description":"Contains information for the kit dispensation.",
    "items":{
        "$ref":"#/components/schemas/DispensationKitV2"
    }
}

Nested Schema : DispensationKit v2.0

Type: object

Title: DispensationKit v2.0

Contains information for the kit dispensation.

Show Source

• id: number (Integer)
  Title: Dispensation Kit ID

  Unique identifier of the dispensation kit.

  Example: 2
• kitDescription: string
  Title: Kit Description

  Kit description.

  Example: Kit A

{
    "title":"DispensationKit v2.0",
    "type":"object",
    "properties":{
        "id":{
            "title":"Dispensation Kit ID",
            "type":"number",
            "description":"Unique identifier of the dispensation kit.",
            "format":"Integer",
            "example":2
        },
        "kitDescription":{
            "title":"Kit Description",
            "type":"string",
            "description":"Kit description.",
            "example":"Kit A"
        }
    },
    "description":"Contains information for the kit dispensation."
}

Examples

Select an example Get Visit Response

400 Response

Invalid subject

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

Examples

Select an example Get Visit Bad Request Response

404 Response

Invalid study ID or version OR Visit for subject does not exist.

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

Examples

Select an example Get Visit Not Found Response

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

Examples

Select an example Get Visit Server Error Response

Back to Top