Jump to

• Request
• Response

Get association between country and site (ISO3 codes)

get

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

Retrieves associations between countries and sites based on site ID and country ID (ISO3 codes). Gets history of changes based on parameters.

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

• history: boolean
  The ISO3 codes of the countries.
• limit: string
  Number of rows to return.
• offset: string
  Row number to start from.
• sdfId: string
  Site ID.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : SDFCountriesResponse2

Type: object

Show Source

• countries: array countries
• sdfCountriesList: array sdfCountriesList

{
    "type":"object",
    "properties":{
        "sdfCountriesList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SDFCountryDto"
            }
        },
        "countries":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CountryDto2"
            }
        }
    }
}

Nested Schema : countries

Type: array

Show Source

• Array of: object CountryDto2

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

Nested Schema : sdfCountriesList

Type: array

Show Source

• Array of: object SDFCountryDto

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

Nested Schema : CountryDto2

Type: object

Show Source

• comment: string
  Minimum Length: 0

  Maximum Length: 2048
• id(required): string (uuid)
• isoCode(required): string
  Minimum Length: 1

  Maximum Length: 10
• isoCode3(required): string
  Minimum Length: 1

  Maximum Length: 10
• name(required): string
  Minimum Length: 1

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

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

{
    "required":[
        "id",
        "isoCode",
        "isoCode3",
        "name"
    ],
    "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"
        },
        "isoCode":{
            "maxLength":"10",
            "minLength":"1",
            "type":"string"
        },
        "name":{
            "maxLength":"100",
            "minLength":"1",
            "type":"string"
        },
        "isoCode3":{
            "maxLength":"10",
            "minLength":"1",
            "type":"string"
        }
    }
}

Nested Schema : SDFCountryDto

Type: object

Show Source

• associationOperationType: string
• comment: string
  Minimum Length: 0

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

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

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

{
    "required":[
        "countryId",
        "primarySupply",
        "sdfId"
    ],
    "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"
        },
        "countryId":{
            "type":"string",
            "format":"uuid"
        },
        "stateId":{
            "type":"string",
            "format":"uuid"
        },
        "sdfId":{
            "type":"string",
            "format":"uuid"
        },
        "primarySupply":{
            "maxLength":"10",
            "minLength":"0",
            "type":"string"
        },
        "associationOperationType":{
            "type":"string",
            "writeOnly":true
        }
    }
}

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