This is a list of the general classes used with the APIs. Classes specific to managing Data Reporter searches are listed separately.
ApiClasses.Study |
Property |
Type |
Description |
Id |
int |
Internal numeric identifier for study |
Name |
string |
Study name |
Description |
string | Study description |
Status |
int | Study status |
ApiClasses.Site |
Property |
Type |
Description |
Name |
string |
Site name |
Description |
string | Site description |
Location |
int | Type of site; remote (1), server (0) |
Status |
int | Site status; 1 for activated, 0 for deactivated |
Country Id |
int | Numeric identifier for country See list of country IDs |
ApiClasses.Country |
Property |
Type |
Description |
Id |
int |
Numeric identifier for country See list of country IDs |
Description |
string | Country name |
Code |
string |
ISO 2-letter country code |
ApiClasses.EFormRoleBasedAccessRule |
Property |
Type |
Description |
ClinicalTrialId |
int |
Internal identifier* for study |
ClinicalTrialname |
string |
Study name |
TrialVersion |
int |
Study version (not currently used elsewhere so always set to 1) |
VisitId |
int |
Internal identifier* for visit |
VisitCode |
string |
Visit code |
EFormId |
int |
Internal identifier* for eForm |
EFormCode |
string |
eForm code |
RoleCode |
string |
User role code |
IsAllowRule |
boolean |
Type of access; Allow (1), Deny (2) |
* Internal identifiers are not used when creating API calls