Jump to

• Request
• Response

Get sites by type or list of countries

get

/ec-site-svc/rest/v1/studies/{studyId}/{mode}/sdfs

Retrieves the SDFs matching the SDF type (Sites/ Depots) or the list of countries ISO codes.

Request

Path Parameters

• mode(required): string
  Mode of the study. Accepts active, test, or training.
• studyId(required): string(uuid)
  The ID of the study.

Query Parameters

• countries: string
  list of countries iso codes
• sdfType: string
  Type of SDF : Sites or Depots.

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 SDFsResponse

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

Nested Schema : SDFsResponse

Type: object

Show Source

• sdfs: array sdfs

{
    "type":"object",
    "properties":{
        "sdfs":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SDFModelDto"
            }
        }
    }
}

Nested Schema : sdfs

Type: array

Show Source

• Array of: object SDFModelDto

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

Nested Schema : SDFModelDto

Type: object

Show Source

• sdf(required): object SDFDto
• sdfAddresses: array sdfAddresses
• sdfPropertyList: array sdfPropertyList

{
    "required":[
        "sdf"
    ],
    "type":"object",
    "properties":{
        "sdf":{
            "$ref":"#/components/schemas/SDFDto"
        },
        "sdfPropertyList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SDFPropertyDto"
            }
        },
        "sdfAddresses":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SDFAddressDto"
            }
        }
    }
}

Nested Schema : SDFDto

Type: object

Show Source

• comment: string
  Minimum Length: 0

  Maximum Length: 2048
• id: string (uuid)
• name(required): string
  Minimum Length: 0

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

  Maximum Length: 255
• sdfType(required): string
  Minimum Length: 0

  Maximum Length: 50
• status(required): string
  Minimum Length: 0

  Maximum Length: 50
• studyOrgId(required): string
  Minimum Length: 0

  Maximum Length: 50
• versionStart: string (date-time)

{
    "required":[
        "name",
        "sdfType",
        "status",
        "studyOrgId"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "comment":{
            "maxLength":"2048",
            "minLength":"0",
            "type":"string"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "name":{
            "maxLength":"200",
            "minLength":"0",
            "type":"string"
        },
        "status":{
            "maxLength":"50",
            "minLength":"0",
            "type":"string"
        },
        "sdfType":{
            "maxLength":"50",
            "minLength":"0",
            "type":"string"
        },
        "studyOrgId":{
            "maxLength":"50",
            "minLength":"0",
            "type":"string"
        }
    }
}

Nested Schema : sdfAddresses

Type: array

Show Source

• Array of: object SDFAddressDto

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

Nested Schema : sdfPropertyList

Type: array

Show Source

• Array of: object SDFPropertyDto

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

Nested Schema : SDFAddressDto

Type: object

Show Source

• addressCity(required): string
  Minimum Length: 0

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

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

  Maximum Length: 20
• addressStateOrProvOrCounty: string
  Minimum Length: 0

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

  Maximum Length: 150

  Pattern: .*[A-z].*|.*\p{L}+.*
• addressStreet2: string
  Minimum Length: 0

  Maximum Length: 150
• addressType(required): string
  Minimum Length: 0

  Maximum Length: 100
• comment: string
  Minimum Length: 0

  Maximum Length: 2048
• email: string
  Minimum Length: 0

  Maximum Length: 255
• fax: string
  Minimum Length: 0

  Maximum Length: 50
• id: string (uuid)
• phone: string
  Minimum Length: 0

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

  Maximum Length: 255
• sdfId: string (uuid)
• versionStart: string (date-time)

{
    "required":[
        "addressCity",
        "addressCountry",
        "addressPostalcode",
        "addressStreet1",
        "addressType"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "comment":{
            "maxLength":"2048",
            "minLength":"0",
            "type":"string"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "sdfId":{
            "type":"string",
            "format":"uuid"
        },
        "addressType":{
            "maxLength":"100",
            "minLength":"0",
            "type":"string"
        },
        "addressStreet1":{
            "maxLength":"150",
            "minLength":"0",
            "pattern":".*[A-z].*|.*\\p{L}+.*",
            "type":"string"
        },
        "addressStreet2":{
            "maxLength":"150",
            "minLength":"0",
            "type":"string"
        },
        "addressCity":{
            "maxLength":"100",
            "minLength":"0",
            "type":"string"
        },
        "addressStateOrProvOrCounty":{
            "maxLength":"100",
            "minLength":"0",
            "type":"string"
        },
        "addressPostalcode":{
            "maxLength":"20",
            "minLength":"0",
            "type":"string"
        },
        "addressCountry":{
            "maxLength":"100",
            "minLength":"0",
            "type":"string"
        },
        "fax":{
            "maxLength":"50",
            "minLength":"0",
            "type":"string"
        },
        "email":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "phone":{
            "maxLength":"50",
            "minLength":"0",
            "type":"string"
        }
    }
}

Nested Schema : SDFPropertyDto

Type: object

Show Source

• comment: string
  Minimum Length: 0

  Maximum Length: 2048
• id: string (uuid)
• propertyName(required): string
  Minimum Length: 0

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

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

  Maximum Length: 255
• sdfId: string (uuid)
• versionStart: string (date-time)

{
    "required":[
        "propertyName",
        "propertyValue"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "comment":{
            "maxLength":"2048",
            "minLength":"0",
            "type":"string"
        },
        "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":"100",
            "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

403 Response

Unauthorised user

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