Jump to

• Request
• Response

v1.0

post

/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/visits/migrateDispensation

Migrates dispensation records

Request

Path Parameters

• mode(required): string
  Mode of the study, accepts: test, active, or training.
• studyId(required): string(uuid)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : MigrationRequest v2.0

Type: object

Title: MigrationRequest v2.0

Request containing migration details.

Show Source

• instanceNumber: number (BigDecimal)
  Title: Instance Number

  Minimum Value: 1

  Visit instance number.

  Example: 2
• kits: array kits
• randomizationListId: string (uuid)
  ID of the randomization list
• randomNumber: number (BigDecimal)
  Title: Random Number

  Random number.

  Example: 2
• siteId(required): string (uuid)
  Title: Site ID

  Site ID.
• studyVersion(required): string
  Title: Version

  Version.

  Example: 1.0.0.5
• subjectId(required): string (uuid)
  Title: Subject ID

  Subject ID.
• visitId(required): string (uuid)
  Title: Visit ID

  Visit ID.
• visitTimestamp(required): string
  Title: Visit Timestamp

  Pattern: (\d){4}-(\d){2}-(\d){2} (\d){2}:(\d){2}:(\d){2}

  Visit timestamp.

  Example: 2022-01-23 18:43:01

{
    "title":"MigrationRequest v2.0",
    "required":[
        "siteId",
        "studyVersion",
        "subjectId",
        "visitId",
        "visitTimestamp"
    ],
    "type":"object",
    "properties":{
        "subjectId":{
            "title":"Subject ID",
            "type":"string",
            "description":"Subject ID.",
            "format":"uuid"
        },
        "siteId":{
            "title":"Site ID",
            "type":"string",
            "description":"Site 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
        },
        "studyVersion":{
            "title":"Version",
            "type":"string",
            "description":"Version.",
            "example":"1.0.0.5"
        },
        "kits":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/MigrationRequestV2"
            }
        },
        "randomNumber":{
            "title":"Random Number",
            "type":"number",
            "description":"Random number.",
            "format":"BigDecimal",
            "example":2
        },
        "randomizationListId":{
            "type":"string",
            "description":"ID of the randomization list",
            "format":"uuid"
        },
        "visitTimestamp":{
            "title":"Visit Timestamp",
            "pattern":"(\\d){4}-(\\d){2}-(\\d){2} (\\d){2}:(\\d){2}:(\\d){2}",
            "type":"string",
            "description":"Visit timestamp.",
            "example":"2022-01-23 18:43:01"
        }
    },
    "description":"Request containing migration details."
}

Nested Schema : kits

Type: array

Show Source

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

  Request containing migration details.

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

Back to Top

Response

200 Response

Successful operation

500 Response

Internal server error

Back to Top