Jump to

• Request
• Response

Get study site details with study version property by site ID

get

/ec-site-svc/rest/v1.0/studies/{studyId}/site/{mode}/{sdfId}

Retrieves the study site details with study version property by site ID.
Right: SiteGet.

Request

Path Parameters

• mode(required): string
  Mode of the study. Accepts active, test, or training.
• sdfId(required): string(uuid)
  Unique ID to identify Site, Lab or Depot (SDF)
• studyId(required): string(uuid)
  The ID of the study.

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 StudySiteLiteResponse

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

Nested Schema : StudySiteLiteResponse

Type: object

Show Source

• sdfPropertyList: array sdfPropertyList
• site: object SiteDetailsLiteDto

{
    "type":"object",
    "properties":{
        "site":{
            "$ref":"#/components/schemas/SiteDetailsLiteDto"
        },
        "sdfPropertyList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SDFPropertyDetailsDto"
            }
        }
    }
}

Nested Schema : sdfPropertyList

Type: array

Show Source

• Array of: object SDFPropertyDetailsDto

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

Nested Schema : SiteDetailsLiteDto

Type: object

Show Source

• comment: string
  Minimum Length: 0

  Maximum Length: 2048
• id: string (uuid)
• institutionId: string (uuid)
• institutionName: string
• objectVersionNumber: number
• oldSdfId: string (uuid)
• operationType: string
  Minimum Length: 1

  Maximum Length: 16
• reason: string
  Minimum Length: 0

  Maximum Length: 255
• softwareVersionNumber: number
• statusId: string (uuid)
• statusIdCodeValue: string
• studyOrgIdName: string
• tenantEntityId: string (uuid)
• userId: string (uuid)
• versionEnd: string (date-time)
• versionStart: string (date-time)

{
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string"
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "operationType":{
            "maxLength":16,
            "minLength":1,
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "tenantEntityId":{
            "type":"string",
            "format":"uuid"
        },
        "studyOrgIdName":{
            "type":"string"
        },
        "statusId":{
            "type":"string",
            "format":"uuid"
        },
        "statusIdCodeValue":{
            "type":"string"
        },
        "oldSdfId":{
            "type":"string",
            "format":"uuid"
        },
        "institutionId":{
            "type":"string",
            "format":"uuid"
        },
        "institutionName":{
            "type":"string"
        }
    }
}

Nested Schema : SDFPropertyDetailsDto

Type: object

Show Source

• comment: string
  Minimum Length: 0

  Maximum Length: 2048
• id: string (uuid)
• objectVersionNumber: number
• operationType: string
  Minimum Length: 1

  Maximum Length: 16
• propertyName(required): string
  Minimum Length: 0

  Maximum Length: 100
• propertyValue(required): string
  Minimum Length: 0

  Maximum Length: 1024
• reason: string
  Minimum Length: 0

  Maximum Length: 255
• sdfId: string (uuid)
• softwareVersionNumber: number
• userId: string (uuid)
• versionEnd: string (date-time)
• versionStart: string (date-time)

{
    "required":[
        "propertyName",
        "propertyValue"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string"
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "operationType":{
            "maxLength":16,
            "minLength":1,
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "sdfId":{
            "type":"string",
            "format":"uuid"
        },
        "propertyName":{
            "maxLength":100,
            "minLength":0,
            "type":"string"
        },
        "propertyValue":{
            "maxLength":1024,
            "minLength":0,
            "type":"string"
        }
    }
}

400 Response

Bad request.

Body ()

Root Schema : SDFResponse

Type: object

Show Source

• errorData: object ErrorResponseData
• result: object result
• status: string

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "result":{
            "type":"object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    }
}

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

Nested Schema : details

Type: object

Back to Top