Medrio Consent API Help

Base Url: https://apac-stagesite5-informedconsent-api.medrio.com/
Build Version: 42.13.0.306

Attachment

API	Description
GET v1/api/{studyId}/Attachment/Subject/{id}	No documentation available.
GET v1/api/{studyId}/Attachment/{id}	No documentation available.
POST v1/api/{studyId}/Attachment	No documentation available.
DELETE v1/api/{studyId}/Attachment/{id}	No documentation available.

Blob

API	Description
GET v1/api/{studyId}/Blob/{blobId}/pdf	No documentation available.
GET v1/api/{studyId}/Blob/{blobId}/download	No documentation available.
POST v1/api/{studyId}/Blob/Upload/SubjectAttachment	No documentation available.
POST v1/api/{studyId}/Blob/Upload/DocumentAttachment	No documentation available.
POST v1/api/{studyId}/Blob/Upload/Document	No documentation available.
POST v1/api/{studyId}/Blob/Upload/Signature	Allows upload of files as multipart/form-data. The Content-Disposition "Name" field should be used for the unique Blob.Code value.

ConfigurationAuditLog

API	Description
GET v1/api/{studyId}/configurationauditlog	No documentation available.
POST v1/api/{studyId}/configurationauditlog/Export	No documentation available.

ConsentApprovalResult

API	Description
GET v1/api/{studyId}/consentapprovalresult	No documentation available.
GET v1/api/{studyId}/consentapprovalresult/{id}	No documentation available.
POST v1/api/{studyId}/consentapprovalresult	Creates new entity. Only one entity per ConsentResult is allowed. ConsentResult must have ConsentSignoffResult. Requires Esignature (username and password)
POST v1/api/{studyId}/consentapprovalresult/many	Creates new entities for array of ConsentResult. Only one entity per ConsentResult is allowed. ConsentResult must have ConsentSignoffResult. Requires Esignature (username and password)
DELETE v1/api/{studyId}/consentapprovalresult/many	Deletes array of ConsentApprovalResult by id. Requires Esignature (username and password)
DELETE v1/api/{studyId}/consentapprovalresult	Deletes ConsentApprovalResult by id. Requires Esignature (username and password)

ConsentDocument

API	Description
GET v1/api/{studyId}/Configuration/ConsentDocument?includeSites={includeSites}&includeSections[0]={includeSections[0]}&includeSections[1]={includeSections[1]}	List of consent documents.
GET v1/api/{studyId}/Configuration/ConsentDocument/{id}	Get a consent document.
GET v1/api/{studyId}/Configuration/ConsentDocument/deletedDocuments	No documentation available.
GET v1/api/{studyId}/Configuration/ConsentDocument/count	Count of consent documents.
GET v1/api/{studyId}/Configuration/ConsentDocument/UatDraftDocuments	No documentation available.
POST v1/api/{studyId}/Configuration/ConsentDocument	Create a consent document.
PUT v1/api/{studyId}/Configuration/ConsentDocument/{id}	Update a consent document.
DELETE v1/api/{studyId}/Configuration/ConsentDocument/{id}	Delete a consent document.
POST v1/api/{studyId}/Configuration/ConsentDocument/BulkDelete	No documentation available.
GET v1/api/{studyId}/Configuration/ConsentDocument/ValidateDocument/{id}	No documentation available.
PUT v1/api/{studyId}/Configuration/ConsentDocument/Recover/{id}	No documentation available.
GET v1/api/{studyId}/Configuration/ConsentDocument/{id}/subject-relationships?includeDefault={includeDefault}	No documentation available.
POST v1/api/{studyId}/Configuration/ConsentDocument/BulkCopy	No documentation available.

ConsentResult

API	Description
GET v1/api/{studyId}/consentresult	No documentation available.
GET v1/api/{studyId}/consentresult/{id}	No documentation available.
GET v1/api/{studyId}/consentresult/subject/{subjectId}	No documentation available.
GET v1/api/{studyId}/consentresult/consentdocument/{consentDocumentId}	No documentation available.
GET v1/api/{studyId}/consentresult/PendingSignoff?mineOnly={mineOnly}	No documentation available.
GET v1/api/{studyId}/consentresult/subject/{subjectId}/consentdocument/{consentDocumentId}/start?timeZone={timeZone}&signator={signator}&actingUserSubjectRelationshipId={actingUserSubjectRelationshipId}	No documentation available.
POST v1/api/{studyId}/consentresult?timeZone={timeZone}	No documentation available.
PUT v1/api/{studyId}/consentresult/{id}	No documentation available.
PUT v1/api/{studyId}/consentresult/{id}/status?timeZone={timeZone}&isStatusUpdatedManually={isStatusUpdatedManually}	No documentation available.
POST v1/api/{studyId}/consentresult/GeneratePdf	No documentation available.
POST v1/api/{studyId}/consentresult/DataEntrySave	Accepts ConsentResult updates from a data entry source.
POST v1/api/{studyId}/consentresult/UploadPaperConsent	Upload the paper consent document.
PUT v1/api/{studyId}/consentresult/removePaperConsent/{attachmentId}	Update paper consent after document remove.
PUT v1/api/{studyId}/consentresult/{id}/relaunchConsent?relaunchAction={relaunchAction}	No documentation available.

ConsentSignoffResult

API	Description
GET v1/api/{studyId}/consentsignoffresult/{id}	No documentation available.
POST v1/api/{studyId}/consentsignoffresult/DataEntrySave	Accepts ConsentSignoffResult updates from a data entry source.

ConsentStatusConfiguration

API	Description
GET v1/api/{studyId}/Configuration/ConsentStatus	Get study consent statuses
DELETE v1/api/{studyId}/Configuration/ConsentStatus/{id}	Delete a status.
GET v1/api/{studyId}/Configuration/ConsentStatus/default	Get the default new consent status

DataAuditLog

API	Description
POST v1/api/{studyId}/dataauditlog	No documentation available.
POST v1/api/{studyId}/dataauditlog/Export	No documentation available.
GET v1/api/{studyId}/dataauditlog/FilterFormParameters	No documentation available.

DeploymentHistory

API	Description
GET v1/api/{studyId}/DeploymentHistory/{toStudyId}	No documentation available.

Email

API	Description
POST v1/api/{studyId}/Email/DocumentToSubject	No documentation available.

FileResult

API	Description
GET v1/api/{studyId}/fileresult/{id}	No documentation available.
POST v1/api/{studyId}/fileresult/DataEntrySave?isLastSection={isLastSection}	Accepts FileResult updates from a data entry source.

FileSection

API	Description
GET v1/api/{studyId}/configuration/consentDocument/{consentDocumentId}/section/file/{id}	No documentation available.
POST v1/api/{studyId}/configuration/consentDocument/{consentDocumentId}/section/file	No documentation available.
PUT v1/api/{studyId}/configuration/consentDocument/{consentDocumentId}/section/file/{id}	No documentation available.
DELETE v1/api/{studyId}/configuration/consentDocument/{consentDocumentId}/section/file/{id}	No documentation available.
POST v1/api/{studyId}/configuration/consentDocument/{consentDocumentId}/section/file/{id}/copy/{targetConsentDocumentId}	No documentation available.
PUT v1/api/{studyId}/configuration/consentDocument/{consentDocumentId}/section/file/{id}/file	No documentation available.

Info

System lookup

API	Description
GET v1/api/{studyId}/info/ConsentResultSystemStatus	Gets all avialable statuses for ConsentResult
GET v1/api/{studyId}/info/ConsentResultSystemStatus/default	No documentation available.

Job

API	Description
GET v1/api/{studyId}/Job/{jobId}	No documentation available.
POST v1/api/{studyId}/Job/GenerateConsentDocuments	No documentation available.
POST v1/api/{studyId}/Job/BulkDownloadPdfs	No documentation available.
GET v1/api/{studyId}/Job/IsDownloadDocumentInProgress	No documentation available.

ManageDocuments

API	Description
GET v1/api/{studyId}/managedocuments	No documentation available.

Role

API	Description
GET v1/api/{studyId}/configuration/role/StaffSignatureAssignableRoles	No documentation available.

Section

API	Description
GET v1/api/{studyId}/configuration/consentDocument/{consentDocumentId}/section	No documentation available.
GET v1/api/{studyId}/configuration/consentDocument/{consentDocumentId}/section/items	No documentation available.
PUT v1/api/{studyId}/configuration/consentDocument/{consentDocumentId}/section/{id}/order/{order}	No documentation available.
GET v1/api/{studyId}/configuration/consentDocument/{consentDocumentId}/section/deleted	No documentation available.
PUT v1/api/{studyId}/configuration/consentDocument/{consentDocumentId}/section/recover	No documentation available.

SectionBuilder

API	Description
POST v1/api/{studyId}/configuration/consentDocument/builder	No documentation available.
POST v1/api/{studyId}/configuration/consentDocument/builder/{documentId}/{fileGuid}	No documentation available.

Signature

API	Description
GET v1/api/{studyId}/signature/{id}	No documentation available.
POST v1/api/{studyId}/signature	No documentation available.

SignoffResult

API	Description
GET v1/api/{studyId}/signoffresult/{id}	No documentation available.
POST v1/api/{studyId}/signoffresult/DataEntrySave	Accepts SignoffResult updates from a data entry source.

SignoffSection

API	Description
GET v1/api/{studyId}/configuration/consentDocument/{consentDocumentId}/section/signoff/{id}	No documentation available.
PUT v1/api/{studyId}/configuration/consentDocument/{consentDocumentId}/section/signoff/{id}	No documentation available.

SiteConsentDocument

API	Description
PUT v1/api/{studyId}/configuration/SiteConsentDocument/site/{siteId}/consentdocument	Update associated ConsentDocuments.
GET v1/api/{studyId}/configuration/SiteConsentDocument/consentdocument/{id}/site	Get associated Sites.
PUT v1/api/{studyId}/configuration/SiteConsentDocument/consentdocument/{id}/site	Update associated Sites.

StaffSignatureSection

API	Description
GET v1/api/{studyId}/configuration/consentDocument/{consentDocumentId}/section/staffSignature/{id}	No documentation available.
POST v1/api/{studyId}/configuration/consentDocument/{consentDocumentId}/section/staffSignature	No documentation available.
PUT v1/api/{studyId}/configuration/consentDocument/{consentDocumentId}/section/staffSignature/{id}	No documentation available.
POST v1/api/{studyId}/configuration/consentDocument/{consentDocumentId}/section/staffSignature/{id}/copy/{targetConsentDocumentId}	No documentation available.
DELETE v1/api/{studyId}/configuration/consentDocument/{consentDocumentId}/section/staffSignature/{id}	No documentation available.

Study

API	Description
GET v1/api/study/{studyId}	No documentation available.
GET v1/api/study/{studyId}/getEdcStudy	No documentation available.
GET v1/api/study/{studyId}/generalConfig	No documentation available.
GET v1/api/study/{studyId}/datetime?dateToConvert={dateToConvert}	No documentation available.
GET v1/api/study/{studyId}/LinkedStudies	No documentation available.
PUT v1/api/study/{studyId}	No documentation available.

StudyDeployment

API	Description
GET v1/api/study/{studyId}/deployment/PendingChanges	No documentation available.
POST v1/api/study/{studyId}/deployment/PreCheck	No documentation available.
POST v1/api/study/{studyId}/deployment/Start	No documentation available.
GET v1/api/study/{studyId}/deployment/{toStudyId}/messages	No documentation available.

Subject

API	Description
GET v1/api/{studyId}/subject?includeResults={includeResults}	No documentation available.
GET v1/api/{studyId}/subject/{id}	No documentation available.
GET v1/api/{studyId}/subject/GetOrAddByEdcId/{edcId}	Finds a subject in consent based on EdcId, or adds it from Edc if it doesn't exist in Consent. NOTE: At the moment, this is the only way to add a subject to Consent.
PUT v1/api/{studyId}/subject/{id}/status?timeZone={timeZone}&isStatusUpdatedManually={isStatusUpdatedManually}	No documentation available.

SubjectAttestation

API	Description
POST v1/api/{studyId}/SubjectAttestation/DataEntrySave	No documentation available.

SubjectConsentActivation

API	Description
POST v1/api/{studyId}/SubjectConsentActivation	Change Consent Activation Status.
POST v1/api/{studyId}/SubjectConsentActivation/documents	Get Consent Activation Documents.
GET v1/api/{studyId}/SubjectConsentActivation/{subjectEdcId}?subjectUserRelationshipId={subjectUserRelationshipId}	No documentation available.

SubjectPortal

API	Description
POST v1/api/{studyId}/SubjectPortal/SiteCoordinatorReview	No documentation available.

SubjectRelationship

API	Description
GET v1/api/{studyId}/configuration/subjectrelationship	No documentation available.

SurveyResult

API	Description
GET v1/api/{studyId}/surveyresult/{id}	No documentation available.
POST v1/api/{studyId}/surveyresult/DataEntrySave?isLastSection={isLastSection}	Accepts SurveyResult updates from a data entry source. Each update should contain the entire SurveyResult record including child collections. The SurveyItemResults collection will be MERGED with existing records. The SurveyItemResultValues collection will REPLACE existing values.

SurveySection

API	Description
GET v1/api/{studyId}/configuration/consentDocument/{consentDocumentId}/section/survey/{id}	No documentation available.
POST v1/api/{studyId}/configuration/consentDocument/{consentDocumentId}/section/survey	No documentation available.
PUT v1/api/{studyId}/configuration/consentDocument/{consentDocumentId}/section/survey/{id}	No documentation available.
POST v1/api/{studyId}/configuration/consentDocument/{consentDocumentId}/section/survey/{id}/copy/{targetConsentDocumentId}	No documentation available.
DELETE v1/api/{studyId}/configuration/consentDocument/{consentDocumentId}/section/survey/{id}	No documentation available.

TimeZoneFormatting

API	Description
GET v1/api/{studyId}/timezoneformatting/formatToTimeZone?date={date}&ianaTimeZone={ianaTimeZone}&withSeconds={withSeconds}	No documentation available.

Translator

API	Description
GET v1/api/{studyId}/Configuration/Translator	Gets list of translators.
GET v1/api/{studyId}/Configuration/Translator/{id}	Gets a translator by id.
GET v1/api/{studyId}/Configuration/Translator/{id}/translations	Gets translations by translator id.

User

API	Description
GET v1/api/user/SoftLockInfo	No documentation available.

Version

API	Description
GET v1/api/version	Retrieves the current version of this web service

VideoResult

API	Description
GET v1/api/{studyId}/videoresult/{id}	No documentation available.
POST v1/api/{studyId}/videoresult/DataEntrySave?isLastSection={isLastSection}	Accepts VideoResult updates from a data source.

VideoSection

API	Description
GET v1/api/{studyId}/configuration/consentDocument/{consentDocumentId}/section/video/{id}	No documentation available.
POST v1/api/{studyId}/configuration/consentDocument/{consentDocumentId}/section/video	No documentation available.
PUT v1/api/{studyId}/configuration/consentDocument/{consentDocumentId}/section/video/{id}	No documentation available.
DELETE v1/api/{studyId}/configuration/consentDocument/{consentDocumentId}/section/video/{id}	No documentation available.
POST v1/api/{studyId}/configuration/consentDocument/{consentDocumentId}/section/video/{id}/copy/{targetConsentDocumentId}	No documentation available.