Jump to

• Request
• Response

v4.0

get

/ec-site-svc/rest/v4/studies/{studyId}/{mode}/sdfcountry

Compared with v3, this version adds pagination (limit and offset) and optional history retrieval.

Request

Path Parameters

• mode(required): string
  Study mode. Allowed values: active (live study operations), test (testing data), training (training or sandbox data).

  Example:

  test

• studyId(required): string(uuid)
  Study identifier as a 32-character uppercase hexadecimal UUID string.

  Example:

  C36A3197FDEE433FB5547EE83DE99E4B

Query Parameters

• history: boolean
  Comma-separated list of ISO alpha-3 country codes.
• limit: string
  Maximum number of rows to return. Only non-negative integers are accepted.
• offset: string
  Zero-based row index to start pagination. Only non-negative integers are accepted.
• sdfId: string
  SDF identifier as a 32-character uppercase hexadecimal UUID 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 : SDFCountriesResponse v2.0

Type: object

Title: SDFCountriesResponse v2.0

Response containing ISO3-based country/SDF associations.

Show Source

• countries: object CountryDto2 v2.0
  Title: CountryDto2 v2.0

  Country metadata for ISO3-enabled APIs.
• sdfCountriesList: object SDFCountryDto v1.0
  Title: SDFCountryDto v1.0

  SDF-country association details returned by the APIs.

{
    "title":"SDFCountriesResponse v2.0",
    "type":"object",
    "properties":{
        "sdfCountriesList":{
            "title":"SDFCountryDto v1.0",
            "required":[
                "countryId",
                "primarySupply",
                "sdfId"
            ],
            "type":"object",
            "properties":{
                "reason":{
                    "title":"Reason",
                    "maxLength":255,
                    "minLength":0,
                    "type":"string",
                    "description":"Reason provided for the audited update.",
                    "example":"Protocol update requested by study operations."
                },
                "comment":{
                    "title":"Comment",
                    "maxLength":2048,
                    "minLength":0,
                    "type":"string",
                    "description":"Additional comment captured for the audited update.",
                    "example":"Association adjusted after data reconciliation."
                },
                "id":{
                    "title":"SDF Country ID",
                    "type":"string",
                    "description":"Unique identifier for the SDF-country association (UUID, 32-character uppercase hexadecimal string).",
                    "format":"uuid"
                },
                "versionStart":{
                    "title":"Version Start",
                    "type":"string",
                    "description":"Timestamp when this association version was created.",
                    "format":"date-time",
                    "example":"2025-03-16T12:00:00Z"
                },
                "countryId":{
                    "title":"Country ID",
                    "type":"string",
                    "description":"Unique identifier of the country linked to the SDF (UUID, 32-character uppercase hexadecimal string).",
                    "format":"uuid"
                },
                "sdfId":{
                    "title":"SDF ID",
                    "type":"string",
                    "description":"Unique SDF identifier (UUID, 32-character uppercase hexadecimal string).",
                    "format":"uuid"
                },
                "primarySupply":{
                    "title":"Primary Supply",
                    "maxLength":10,
                    "minLength":0,
                    "type":"string",
                    "description":"Primary supply type for the SDF-country association.",
                    "example":"PRIMARY"
                }
            },
            "description":"SDF-country association details returned by the APIs.",
            "example":[
                {
                    "id":"3F2504E04F8911D39A0C0305E82C3301",
                    "versionStart":"2025-03-16T12:00:00.000Z",
                    "countryId":"A0E1B2C3D4E5F67890123456789ABCDE",
                    "sdfId":"9C10C9F402C44BD6A7CFC7F4F1A6EED8",
                    "primarySupply":"PRIMARY"
                }
            ]
        },
        "countries":{
            "title":"CountryDto2 v2.0",
            "required":[
                "id",
                "isoCode",
                "isoCode3",
                "name"
            ],
            "type":"object",
            "properties":{
                "reason":{
                    "title":"Reason",
                    "maxLength":255,
                    "minLength":0,
                    "type":"string",
                    "description":"Reason provided for the audited update.",
                    "example":"Protocol update requested by study operations."
                },
                "comment":{
                    "title":"Comment",
                    "maxLength":2048,
                    "minLength":0,
                    "type":"string",
                    "description":"Additional comment captured for the audited update.",
                    "example":"Association adjusted after data reconciliation."
                },
                "id":{
                    "title":"Country ID",
                    "type":"string",
                    "description":"Unique country identifier (UUID, 32-character uppercase hexadecimal string).",
                    "format":"uuid"
                },
                "versionStart":{
                    "title":"Version Start",
                    "type":"string",
                    "description":"Timestamp when this country version was created.",
                    "format":"date-time",
                    "example":"2025-03-16T12:00:00Z"
                },
                "isoCode":{
                    "title":"ISO Code",
                    "maxLength":10,
                    "minLength":1,
                    "type":"string",
                    "description":"Alpha-2 ISO code identifying the country.",
                    "example":"US"
                },
                "name":{
                    "title":"Country Name",
                    "maxLength":100,
                    "minLength":1,
                    "type":"string",
                    "description":"Official country name.",
                    "example":"United States"
                },
                "isoCode3":{
                    "title":"ISO Code 3",
                    "maxLength":10,
                    "minLength":1,
                    "type":"string",
                    "description":"Alpha-3 ISO code identifying the country.",
                    "example":"USA"
                }
            },
            "description":"Country metadata for ISO3-enabled APIs.",
            "example":[
                {
                    "id":"A0E1B2C3D4E5F67890123456789ABCDE",
                    "versionStart":"2025-03-16T12:00:00.000Z",
                    "isoCode":"US",
                    "name":"United States",
                    "isoCode3":"USA"
                }
            ]
        }
    },
    "description":"Response containing ISO3-based country/SDF associations."
}

Nested Schema : CountryDto2 v2.0

Type: object

Title: CountryDto2 v2.0

Country metadata for ISO3-enabled APIs.

Show Source

• comment: string
  Title: Comment

  Minimum Length: 0

  Maximum Length: 2048

  Additional comment captured for the audited update.

  Example: Association adjusted after data reconciliation.
• id(required): string (uuid)
  Title: Country ID

  Unique country identifier (UUID, 32-character uppercase hexadecimal string).
• isoCode(required): string
  Title: ISO Code

  Minimum Length: 1

  Maximum Length: 10

  Alpha-2 ISO code identifying the country.

  Example: US
• isoCode3(required): string
  Title: ISO Code 3

  Minimum Length: 1

  Maximum Length: 10

  Alpha-3 ISO code identifying the country.

  Example: USA
• name(required): string
  Title: Country Name

  Minimum Length: 1

  Maximum Length: 100

  Official country name.

  Example: United States
• reason: string
  Title: Reason

  Minimum Length: 0

  Maximum Length: 255

  Reason provided for the audited update.

  Example: Protocol update requested by study operations.
• versionStart: string (date-time)
  Title: Version Start

  Timestamp when this country version was created.

  Example: 2025-03-16T12:00:00Z

{
    "title":"CountryDto2 v2.0",
    "required":[
        "id",
        "isoCode",
        "isoCode3",
        "name"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "title":"Reason",
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Reason provided for the audited update.",
            "example":"Protocol update requested by study operations."
        },
        "comment":{
            "title":"Comment",
            "maxLength":2048,
            "minLength":0,
            "type":"string",
            "description":"Additional comment captured for the audited update.",
            "example":"Association adjusted after data reconciliation."
        },
        "id":{
            "title":"Country ID",
            "type":"string",
            "description":"Unique country identifier (UUID, 32-character uppercase hexadecimal string).",
            "format":"uuid"
        },
        "versionStart":{
            "title":"Version Start",
            "type":"string",
            "description":"Timestamp when this country version was created.",
            "format":"date-time",
            "example":"2025-03-16T12:00:00Z"
        },
        "isoCode":{
            "title":"ISO Code",
            "maxLength":10,
            "minLength":1,
            "type":"string",
            "description":"Alpha-2 ISO code identifying the country.",
            "example":"US"
        },
        "name":{
            "title":"Country Name",
            "maxLength":100,
            "minLength":1,
            "type":"string",
            "description":"Official country name.",
            "example":"United States"
        },
        "isoCode3":{
            "title":"ISO Code 3",
            "maxLength":10,
            "minLength":1,
            "type":"string",
            "description":"Alpha-3 ISO code identifying the country.",
            "example":"USA"
        }
    },
    "description":"Country metadata for ISO3-enabled APIs.",
    "example":[
        {
            "id":"A0E1B2C3D4E5F67890123456789ABCDE",
            "versionStart":"2025-03-16T12:00:00.000Z",
            "isoCode":"US",
            "name":"United States",
            "isoCode3":"USA"
        }
    ]
}

Example:

[
    {
        "id":"A0E1B2C3D4E5F67890123456789ABCDE",
        "versionStart":"2025-03-16T12:00:00.000Z",
        "isoCode":"US",
        "name":"United States",
        "isoCode3":"USA"
    }
]

Nested Schema : SDFCountryDto v1.0

Type: object

Title: SDFCountryDto v1.0

SDF-country association details returned by the APIs.

Show Source

• comment: string
  Title: Comment

  Minimum Length: 0

  Maximum Length: 2048

  Additional comment captured for the audited update.

  Example: Association adjusted after data reconciliation.
• countryId(required): string (uuid)
  Title: Country ID

  Unique identifier of the country linked to the SDF (UUID, 32-character uppercase hexadecimal string).
• id: string (uuid)
  Title: SDF Country ID

  Unique identifier for the SDF-country association (UUID, 32-character uppercase hexadecimal string).
• primarySupply(required): string
  Title: Primary Supply

  Minimum Length: 0

  Maximum Length: 10

  Primary supply type for the SDF-country association.

  Example: PRIMARY
• reason: string
  Title: Reason

  Minimum Length: 0

  Maximum Length: 255

  Reason provided for the audited update.

  Example: Protocol update requested by study operations.
• sdfId(required): string (uuid)
  Title: SDF ID

  Unique SDF identifier (UUID, 32-character uppercase hexadecimal string).
• versionStart: string (date-time)
  Title: Version Start

  Timestamp when this association version was created.

  Example: 2025-03-16T12:00:00Z

{
    "title":"SDFCountryDto v1.0",
    "required":[
        "countryId",
        "primarySupply",
        "sdfId"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "title":"Reason",
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Reason provided for the audited update.",
            "example":"Protocol update requested by study operations."
        },
        "comment":{
            "title":"Comment",
            "maxLength":2048,
            "minLength":0,
            "type":"string",
            "description":"Additional comment captured for the audited update.",
            "example":"Association adjusted after data reconciliation."
        },
        "id":{
            "title":"SDF Country ID",
            "type":"string",
            "description":"Unique identifier for the SDF-country association (UUID, 32-character uppercase hexadecimal string).",
            "format":"uuid"
        },
        "versionStart":{
            "title":"Version Start",
            "type":"string",
            "description":"Timestamp when this association version was created.",
            "format":"date-time",
            "example":"2025-03-16T12:00:00Z"
        },
        "countryId":{
            "title":"Country ID",
            "type":"string",
            "description":"Unique identifier of the country linked to the SDF (UUID, 32-character uppercase hexadecimal string).",
            "format":"uuid"
        },
        "sdfId":{
            "title":"SDF ID",
            "type":"string",
            "description":"Unique SDF identifier (UUID, 32-character uppercase hexadecimal string).",
            "format":"uuid"
        },
        "primarySupply":{
            "title":"Primary Supply",
            "maxLength":10,
            "minLength":0,
            "type":"string",
            "description":"Primary supply type for the SDF-country association.",
            "example":"PRIMARY"
        }
    },
    "description":"SDF-country association details returned by the APIs.",
    "example":[
        {
            "id":"3F2504E04F8911D39A0C0305E82C3301",
            "versionStart":"2025-03-16T12:00:00.000Z",
            "countryId":"A0E1B2C3D4E5F67890123456789ABCDE",
            "sdfId":"9C10C9F402C44BD6A7CFC7F4F1A6EED8",
            "primarySupply":"PRIMARY"
        }
    ]
}

Example:

[
    {
        "id":"3F2504E04F8911D39A0C0305E82C3301",
        "versionStart":"2025-03-16T12:00:00.000Z",
        "countryId":"A0E1B2C3D4E5F67890123456789ABCDE",
        "sdfId":"9C10C9F402C44BD6A7CFC7F4F1A6EED8",
        "primarySupply":"PRIMARY"
    }
]

Examples

Select an example Success Response

400 Response

Returned when one or more path parameters, query parameters, or request-body values fail endpoint validation.

Body ()

Root Schema : SDFResponse

Type: object

Title: SDFResponse

Wrapper for service responses containing result or error data.

Show Source

• errorData: object ErrorResponseData
• result: object result
  The result object for successful requests. Type depends on the API operation.
• status: string
  Status of the response, either 'success' or an error indication.

  Example: success

{
    "title":"SDFResponse",
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of the response, either 'success' or an error indication.",
            "example":"success"
        },
        "result":{
            "type":"object",
            "description":"The result object for successful requests. Type depends on the API operation.",
            "example":{
                "hasMore":"true",
                "totalResults":5,
                "count":5,
                "data":[
                ]
            }
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    },
    "description":"Wrapper for service responses containing result or error data."
}

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

The result object for successful requests. Type depends on the API operation.

Example:

{
    "hasMore":"true",
    "totalResults":5,
    "count":5,
    "data":[
    ]
}

Nested Schema : details

Type: object

Examples

Select an example Bad Request Response

Back to Top