MACRO API

 

MACRO API routines in alphabetic order

You can also see a list of functionality available by task...

 

Routine

Description

ActivateSite

Enable/disable an existing site

AddEformAccessRule

Create a new eForm access rule

AddSearchToQueue

Add a Data Reporter search to the queue

AddSubjectToSubjectGroup

Add a subject to a static subject group

ArezzoCheck

Check the syntax of a single Arezzo expression

ArezzoEvaluate

Evaluate Arezzo expressions at any level of a specified MACRO subject

ArezzoEvaluateSubject

Evaluate a list of Arezzo expressions for a specified MACRO subject

AssignSiteToStudy

Associate a site with a study

AssignUserRoleToSubjectGroup

Assign user access to a subject group

CancelSearchQueueItem

Cancel a queued Data Reporter search

ChangeUserPassword

Change your own password

CreateDcr

Create a new Raised DCR

CreateSdv

Create a new/change an existing SDV

CreateSearch

Create and save a new Data Reporter search

CreateSite

Create a new site

CreateSQLServerDatabase

Create a new SQL Server data or security database

CreateSubject

Create a new subject with an automatically generated subject ID.

CreateSubjectGroup

Create new subject group

CreateUser

Create a new user

EditSubjectGroupCondition

Edit the Arezzo condition that defines a subject group

EditSubjectGroupIsDynamic

Specify whether a subject group is dynamic or static

DeleteSearch

Delete a Data Reporter search definition from the database

DeleteSearchQueueItem

Remove a Data Reporter search from the queue

EditAdminUser

Change the administrator who is associated with an existing user

EditDCR

Change the status of an existing DCR to Responded, Closed or Raised, and edit the DCR text

EditSearch

Edit a Data Reporter search

EditSite

Edit an existing site

EditSubjectGroupDescription

Edit the description for an existing subject group

EditSysAdminStatus

Change the system administrator status for an existing user

EditUserEmail

Change the email for an existing user

EditUserName

Change the full name of an existing user

EnableUser

Enable or disable a user

EvaluateSubjectForSubjectGroup

Evaluate a subject for a given group

EvaluateSubjectGroupsForSubject

Evaluate the subject groups for a given subject

ExportAssociations

Export study/site/user/role associations

ExportCategories

Export existing codes and descriptions for category questions

ExportLaboratory

Export MACRO v4 laboratory definition

ExportStudy

Export MACRO v4 study definition

ExportStudyCDISC

Export MACRO v4 CDISC study definition

ExportSubjects

Export MACRO v4 subject data in MACRO format

ExportSubjectsCDISC

Export MACRO v4 subject data in CDISC format

GetAccessRules

Retrieve a list of eForm access rules for a given eForm/visit/role combination

GetCDISCSubjectData

Request data in CDISC format

GetCountries

Retrieve a list of countries used by MACRO

GetEvents

Retrieve specified current event records

GetHistoryEvents

Retrieve specified current event records from the audit trail

GetNewEvents

Retrieve new current event records

GetRequestedEforms

Retrieve the details of all eForms with Requested status for all subjects in a study

GetSearch

Retrieve details of a Data Reporter search

GetSearchesForUser

Retrieve a list of Data Reporter searches that the specified user has permission to view

GetSearchQueue

View Data Reporter searches in the queue

GetSites

Retrieve a list of sites in the current database

GetSitesForStudy

Retrieve a list of sites associated with a study

GetStudies

Retrieve a list of studies in the current database

GetStudiesForSite

Retrieve a list of studies associated with a site

GetSubjectData

Request data in XML format

GetSubjectGroups

Retrieve a list of subject groups

GetSubjectGroupsForStudy

Retrieve a list of subject groups for a given study

GetSubjectGroupsForSubject

Retrieve a list of subject groups in which a given subject is included

GetSubjectGroupsForUserRole

Retrieve a list of subject groups in which a given user is included with a particular user role

GetSubjectsInSubjectGroup

Retrieve a list of subjects in a given subject group

ImportAssociations

Import study/site/user/role associations

ImportCategories

Import codes and descriptions for category questions

ImportLaboratory

Import MACRO v4 laboratory definition

ImportLaboratoryM3

Import MACRO v3 laboratory definition

ImportStudy

Import MACRO v4 study definition

ImportStudyCDISC

Import MACRO v4 CDISC study definition

ImportStudyM3

Import MACRO v3 study definition

ImportSubjects

Import MACRO v4 subject data in MACRO format

ImportSubjectsCDISC

Import MACRO v4 subject data in CDISC format

ImportSubjectsM3

Import MACRO v3 subject data in MACRO format

InputSubjectData

Enter data

LoadSearchResults

Retrieve the results of a completed Data Reporter search in columnar view

LoadSearchResultsFrequencyView

Retrieve the results of a completed Data Reporter search in frequency view

LoadSearchResultsCrossTabulationView

Retrieve the results of a completed Data Reporter search in cross tabular view

LockFreeze

Freeze/lock any existing MACRO object

Login

Log in to a MACRO database

LoginSecurity

Log in specifying a security database

RegisterSQLServerDatabase

Register a SQL Server data database

RegisterSubject

Register a subject

RemoveEformAccessRule

Delete an existing eForm access rule

RemoveSiteFromStudy

Disassociate a site from a study

RemoveSubjectFromSubjectGroup

Remove a subject from a static subject group

RemoveUserRoleFromSubjectGroup

Remove user access from a subject group

ResetPassword

Change another user's password

SetEventStatus

Change the status of a current event

SetSubjectGroupActive

Activate or deactivate a subject group

UnlockUser

Unlock a user who has been locked out of MACRO due to entering an incorrect password

UnregisterSQLServerDatabase

Unregister a SQL Server data database

UpdateJobSchedule

Schedule a Data Reporter search

 

 

Related Topics