Get list of regions with history
get
/ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/regions/history
Retrieves a list of all regions with history. Includes list of their countries and states associations with hidden flag. Rights required: RegionGet.
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 TopResponse
Supported Media Types
- application/json
200 Response
Success
Nested Schema : SDFAddressv20
Type:
Show Source
object
-
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)
400 Response
Bad Request
Nested Schema : result
Type:
object
Nested Schema : details
Type:
object
403 Response
Unauthorised user
Nested Schema : result
Type:
object
Nested Schema : details
Type:
object