Jump to

• Request
• Response

Get list of countries and states with hidden flag associated to a region

get

/ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/regions/countries/history

Get list of countries and states with hidden flag associated to a region

Request

Path Parameters

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

Query Parameters

• fromDate: string
  Date after which the records have to be fetched for a GET API
• limit: integer(int32)
  Minimum Value: 0

  number of records
• offset: integer(int32)
  Minimum Value: 0

  starting offset
• order: string
  asc or desc
• regionId: string
  Unique Id for a given region.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object SDFAddressv20

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

Nested Schema : SDFAddressv20

Type: object

Show Source

• addressCity: string
• addressCountry: string
• addressPostalcode: string
• addressStateOrProvOrCounty: string
• addressStreet1: string
• addressStreet2: string
• addressType: string
• comment: string
  Minimum Length: 0

  Maximum Length: 2048
• email: string
• fax: string
• id: string (uuid)
• objectVersionNumber: number
• operationType: string
• phone: string
• reason: string
  Minimum Length: 0

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

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "operationType":{
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "reason":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "comment":{
            "maxLength":"2048",
            "minLength":"0",
            "type":"string"
        },
        "sdfId":{
            "type":"string",
            "format":"uuid"
        },
        "addressType":{
            "type":"string"
        },
        "addressStreet1":{
            "type":"string"
        },
        "addressStreet2":{
            "type":"string"
        },
        "addressCity":{
            "type":"string"
        },
        "addressStateOrProvOrCounty":{
            "type":"string"
        },
        "addressPostalcode":{
            "type":"string"
        },
        "addressCountry":{
            "type":"string"
        },
        "fax":{
            "type":"string"
        },
        "email":{
            "type":"string"
        },
        "phone":{
            "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