Jump to

• Request
• Response

[Deprecated]: v1.0

get

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

Deprecated: Retrieves sites by study ID. Rights: OrsInventoryGet. DEPRECATED - use /ec-site-svc/rest/v2.0/studies/{studyId}/{mode}/sdfs/sdf/{sdfType}

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

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 SDFModel
  Contains site and depot detail

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

Nested Schema : SDFModel

Type: object

Contains site and depot detail

Show Source

• attention: string
  Attention
• depot: boolean
  Is it depot

  Example: true
• primaryAddress: object shippingAddress
  Title: shippingAddress

  Contains site/depot address.
• prinicalInvestigator: string
• sdf: object SDFs
  Contains site and depot detail
• sdfAddresses: array sdfAddresses
• sdfPropertyList: array sdfPropertyList
• shippingAddress: object shippingAddress
  Title: shippingAddress

  Contains site/depot address.
• studyVersion: string
  String representing the version of the study. Helps track changes in form or study design.

  Example: 1.0.0.1

{
    "type":"object",
    "properties":{
        "sdf":{
            "$ref":"#/components/schemas/SDFs"
        },
        "sdfPropertyList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SDFProperty"
            }
        },
        "sdfAddresses":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SDFAddress"
            }
        },
        "primaryAddress":{
            "$ref":"#/components/schemas/SDFAddress"
        },
        "shippingAddress":{
            "$ref":"#/components/schemas/SDFAddress"
        },
        "studyVersion":{
            "type":"string",
            "description":"String representing the version of the study. Helps track changes in form or study design.",
            "example":"1.0.0.1"
        },
        "attention":{
            "type":"string",
            "description":"Attention"
        },
        "depot":{
            "type":"boolean",
            "description":"Is it depot",
            "example":true
        },
        "prinicalInvestigator":{
            "type":"string"
        }
    },
    "description":"Contains site and depot detail"
}

Nested Schema : shippingAddress

Type: object

Title: shippingAddress

Contains site/depot address.

Show Source

• address: string
• addressCity: string
  Address city
• addressCountry: string
  Address country
• addressCounty: string
  Address county
• addressPostalcode: string
  Address postal code
• addressStateOrProvOrCounty: string
  Address state/province/county
• addressStreet1: string
  Address Street1 detail
• addressStreet2: string
  Address Street2 detail
• addressType: string
  Type of address name

  Example: Primary/Shipping
• email: string
  Email Address
• fax: string
  Fax number
• id: string (uuid)
  Unique id for site/depot address
• phone: string
  Phone number
• sdfId: string (uuid)
  Unique id for site/depot
• versionStart: string (date-time)
  The timestamp marking the beginning of the validity period for this record version within the system.

{
    "title":"shippingAddress",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique id for site/depot address",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "description":"The timestamp marking the beginning of the validity period for this record version within the system.",
            "format":"date-time"
        },
        "sdfId":{
            "type":"string",
            "description":"Unique id for site/depot",
            "format":"uuid"
        },
        "addressType":{
            "type":"string",
            "description":"Type of address name",
            "example":"Primary/Shipping"
        },
        "addressStreet1":{
            "type":"string",
            "description":"Address Street1 detail"
        },
        "addressStreet2":{
            "type":"string",
            "description":"Address Street2 detail"
        },
        "addressCity":{
            "type":"string",
            "description":"Address city"
        },
        "addressCounty":{
            "type":"string",
            "description":"Address county"
        },
        "addressStateOrProvOrCounty":{
            "type":"string",
            "description":"Address state/province/county"
        },
        "addressPostalcode":{
            "type":"string",
            "description":"Address postal code"
        },
        "addressCountry":{
            "type":"string",
            "description":"Address country"
        },
        "email":{
            "type":"string",
            "description":"Email Address"
        },
        "fax":{
            "type":"string",
            "description":"Fax number"
        },
        "phone":{
            "type":"string",
            "description":"Phone number"
        },
        "address":{
            "type":"string"
        }
    },
    "description":"Contains site/depot address."
}

Nested Schema : SDFs

Type: object

Contains site and depot detail

Show Source

• designId: string (uuid)
  Unique id for design
• designVersionStart: string (date-time)
  Design Version start
• id: string (uuid)
  Unique id for site/depot
• name: string
  Site name

  Example: Site1001
• sdfType: string
  Site/Depot type

  Example: Site/Depot
• status: string
  Allowed Values: [ "new", "active", "retired" ]

  Site status

  Example: new
• studyOrgId: string
  Site/Depot org id

  Example: Site1001
• versionStart: string (date-time)
  The timestamp marking the beginning of the validity period for this record version within the system.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique id for site/depot",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "description":"The timestamp marking the beginning of the validity period for this record version within the system.",
            "format":"date-time"
        },
        "name":{
            "type":"string",
            "description":"Site name",
            "example":"Site1001"
        },
        "status":{
            "type":"string",
            "description":"Site status",
            "example":"new",
            "enum":[
                "new",
                "active",
                "retired"
            ]
        },
        "sdfType":{
            "type":"string",
            "description":"Site/Depot type",
            "example":"Site/Depot"
        },
        "studyOrgId":{
            "type":"string",
            "description":"Site/Depot org id",
            "example":"Site1001"
        },
        "designId":{
            "type":"string",
            "description":"Unique id for design",
            "format":"uuid"
        },
        "designVersionStart":{
            "type":"string",
            "description":"Design Version start",
            "format":"date-time"
        }
    },
    "description":"Contains site and depot detail"
}

Nested Schema : sdfAddresses

Type: array

Show Source

• Array of: object shippingAddress
  Title: shippingAddress

  Contains site/depot address.

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

Nested Schema : sdfPropertyList

Type: array

Show Source

• Array of: object SDFProperty

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

Nested Schema : SDFProperty

Type: object

Show Source

• comment: string
  Minimum Length: 0

  Maximum Length: 2048

  Additional user comment about the latest change.

  Example: Association adjusted after data reconciliation.
• id: string (uuid)
  Pattern: ^[A-F0-9]{32}$

  Unique identifier for this record.
• propertyName(required): string
  Minimum Length: 0

  Maximum Length: 100

  Name of the property.

  Example: timezone
• propertyValue(required): string
  Minimum Length: 0

  Maximum Length: 2048

  Value of the property.

  Example: UTC
• reason: string
  Minimum Length: 0

  Maximum Length: 255

  Reason for the latest change made to this record.

  Example: Protocol update requested by study operations.
• sdfId: string (uuid)
  Pattern: ^[A-F0-9]{32}$

  Identifier of the related SDF record.
• versionStart: string (date-time)

{
    "required":[
        "propertyName",
        "propertyValue"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Reason for the latest change made to this record.",
            "example":"Protocol update requested by study operations."
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string",
            "description":"Additional user comment about the latest change.",
            "example":"Association adjusted after data reconciliation."
        },
        "id":{
            "pattern":"^[A-F0-9]{32}$",
            "type":"string",
            "description":"Unique identifier for this record.",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "sdfId":{
            "pattern":"^[A-F0-9]{32}$",
            "type":"string",
            "description":"Identifier of the related SDF record.",
            "format":"uuid"
        },
        "propertyName":{
            "maxLength":100,
            "minLength":0,
            "type":"string",
            "description":"Name of the property.",
            "example":"timezone"
        },
        "propertyValue":{
            "maxLength":2048,
            "minLength":0,
            "type":"string",
            "description":"Value of the property.",
            "example":"UTC"
        }
    }
}

Examples

Select an example Get Sites Response

404 Response

Invalid study ID or version

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 Sites 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 Sites Server Error Response

Back to Top