docs.jsonld
type: ApiDocumentation
title: eConsent API
entrypoint: /
supported class: Error
supported class: ConstraintViolationList
supported class: AuditTrail
supported class: Country
supported class: EmailTemplate
supported class: EmailTemplateTranslation
supported class: StudyEmailTemplate
supported class: ExternalSignatureRequest
supported class: FeatureFlag
supported class: FormBlock
supported class: FormBlockAnswerOption
supported class: FormBlockQuestion
supported class: SubjectRelationship
supported class: InformedConsentForm
supported class: InformedConsentFormCountry
supported class: InformedConsentFormPdf
supported class: InformedConsentFormStudySite
supported class: PaperTemplate
supported class: Language
supported class: Locale
supported class: Organization
supported class: Report
supported class: Site
supported class: StudySiteRole
supported class: StudySite
supported class: Integration
supported class: StudyIntegration
supported class: StudyInvitation
supported class: StudyRole
supported class: Study
supported class: StudyLogo
supported class: StudyWithdrawalSetting
supported class: SubjectRole
supported class: Subject
supported class: SubjectFormBlock
supported class: SubjectFormBlockAnswer
supported class: SubjectFormBlockValue
supported class: SubjectInformedConsentForm
supported class: InPersonSigningLock
supported class: InviteSigner
supported class: PaperSignedFile
supported class: Signer
supported class: SubjectProfile
supported class: SubjectVideoCall
supported class: User
supported class: VideoCallToken
supported class: Webhook
supported class: Entrypoint
supported class: ConstraintViolation

Error
type: Class
title: Error
supported property: SupportedProperty
  property: title
  title: title
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: detail
  title: detail
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: instance
  title: instance
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: type
  title: type
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: trace
  title: trace
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: message
  title: message
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: code
  title: code
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: file
  title: file
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: line
  title: line
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: description
  title: description
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: string
  title: string
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: trace
  title: trace
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: previous
  title: previous
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: traceAsString
  title: traceAsString
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a Error resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Error resource.
  returns: Error
supported operation: Retrieves a Error resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Error resource.
  returns: Error
supported operation: Retrieves a Error resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Error resource.
  returns: Error
supported operation: Retrieves a Error resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Error resource.
  returns: Error

title
type: Property
domain: Error
range: string

detail
type: Property
domain: Error
range: string

status
type: Property
domain: Error
range: integer

instance
type: Property
domain: Error
range: string

type
type: Property
domain: Error
range: string

trace
type: Property
domain: Error

message
type: Property
domain: Error
range: string

code
type: Property
domain: Error
range: integer

file
type: Property
domain: Error
range: string

line
type: Property
domain: Error
range: integer

description
type: Property
domain: Error
range: string

string
type: Property
domain: Error

previous
type: Property
domain: Error

traceAsString
type: Property
domain: Error
range: string

ConstraintViolationList
type: Class
title: ConstraintViolationList
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: errorTitle
  title: errorTitle
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: violations
  title: violations
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: detail
  title: detail
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: message
  title: message
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: code
  title: code
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: file
  title: file
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: line
  title: line
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: description
  title: description
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: type
  title: type
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: title
  title: title
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: instance
  title: instance
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: statusCode
  title: statusCode
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: headers
  title: headers
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: string
  title: string
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: trace
  title: trace
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: previous
  title: previous
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: traceAsString
  title: traceAsString
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a ConstraintViolationList resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a ConstraintViolationList resource.
  returns: ConstraintViolationList
supported operation: Retrieves a ConstraintViolationList resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a ConstraintViolationList resource.
  returns: ConstraintViolationList
supported operation: Retrieves a ConstraintViolationList resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a ConstraintViolationList resource.
  returns: ConstraintViolationList
description: Thrown when a validation error occurs.
subclass of: Error
title: A constraint violation list
supported property: SupportedProperty
  property: violations
  title: violations
  description: The violations
  readable: true
  writeable: false

status
type: Property
domain: ConstraintViolationList
range: integer

errorTitle
type: Property
domain: ConstraintViolationList
range: string

violations
type: Property
domain: ConstraintViolationList
range: ConstraintViolation

detail
type: Property
domain: ConstraintViolationList
range: string

message
type: Property
domain: ConstraintViolationList
range: string

code
type: Property
domain: ConstraintViolationList
range: string
range: integer

file
type: Property
domain: ConstraintViolationList
range: string

line
type: Property
domain: ConstraintViolationList
range: integer

description
type: Property
domain: ConstraintViolationList
range: string

type
type: Property
domain: ConstraintViolationList
range: string

title
type: Property
domain: ConstraintViolationList
range: string

instance
type: Property
domain: ConstraintViolationList
range: string

statusCode
type: Property
domain: ConstraintViolationList
range: integer

headers
type: Property
domain: ConstraintViolationList

string
type: Property
domain: ConstraintViolationList

trace
type: Property
domain: ConstraintViolationList

previous
type: Property
domain: ConstraintViolationList

traceAsString
type: Property
domain: ConstraintViolationList
range: string

AuditTrail
type: Class
title: AuditTrail
supported property: SupportedProperty
  property: eventDateTime
  title: eventDateTime
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: eventType
  title: eventType
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: user
  title: user
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: changeSet
  title: changeSet
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: data
  title: data
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: subjectId
  title: subjectId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: studyId
  title: studyId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: siteId
  title: siteId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: organizationId
  title: organizationId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: userEmail
  title: userEmail
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: userName
  title: userName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: userRoles
  title: userRoles
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: userType
  title: userType
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: studyStatus
  title: studyStatus
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ipAddressHash
  title: ipAddressHash
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: clock
  title: clock
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: eventType
  title: eventType
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: eventDateTime
  title: eventDateTime
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: userEmail
  title: userEmail
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: userName
  title: userName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: userType
  title: userType
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: studyStatus
  title: studyStatus
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: userRoles
  title: userRoles
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: data
  title: data
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: subjectId
  title: subjectId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: studyId
  title: studyId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: siteId
  title: siteId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: changeSet
  title: changeSet
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: subjectScreeningId
  title: subjectScreeningId
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a AuditTrail resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a AuditTrail resource.
  returns: AuditTrail

eventDateTime
type: Property
domain: AuditTrail
range: dateTime
range: string

eventType
type: Property
domain: AuditTrail
range: string

user
type: Link
domain: AuditTrail
max cardinality: 1
range: User

changeSet
type: Property
domain: AuditTrail
range: string

data
type: Property
domain: AuditTrail
range: string

subjectId
type: Property
domain: AuditTrail
range: string

studyId
type: Property
domain: AuditTrail
range: string

siteId
type: Property
domain: AuditTrail
range: string

organizationId
type: Property
domain: AuditTrail
range: string

userEmail
type: Property
domain: AuditTrail
range: string

userName
type: Property
domain: AuditTrail
range: string

userRoles
type: Property
domain: AuditTrail
range: string

userType
type: Property
domain: AuditTrail
range: string

studyStatus
type: Property
domain: AuditTrail
range: string

ipAddressHash
type: Property
domain: AuditTrail
range: string

clock
type: Property
domain: AuditTrail

id
type: Property
domain: AuditTrail
range: string

subjectScreeningId
type: Property
domain: AuditTrail
range: string

Country
type: Class
title: Country
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: nameTranslated
  title: nameTranslated
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: alpha2
  title: alpha2
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a Country resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Country resource.
  returns: Nothing

name
type: Property
domain: Country
range: string

nameTranslated
type: Property
domain: Country
range: string

alpha2
type: Property
domain: Country
range: string

EmailTemplate
type: Class
title: EmailTemplate
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: type
  title: type
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: fromAddress
  title: fromAddress
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: emailTemplateTranslations
  title: emailTemplateTranslations
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a EmailTemplate resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a EmailTemplate resource.
  returns: EmailTemplate
supported operation: Replaces the EmailTemplate resource.
  type: Operation
  type: ReplaceAction
  expects: EmailTemplate
  method: PUT
  title: Replaces the EmailTemplate resource.
  returns: EmailTemplate
supported operation: Updates the EmailTemplate resource.
  type: Operation
  expects: EmailTemplate
  method: PATCH
  title: Updates the EmailTemplate resource.
  returns: EmailTemplate
supported operation: Deletes the EmailTemplate resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the EmailTemplate resource.
  returns: Nothing

id
type: Property
domain: EmailTemplate
range: string

type
type: Property
domain: EmailTemplate

fromAddress
type: Property
domain: EmailTemplate

emailTemplateTranslations
type: Property
domain: EmailTemplate

EmailTemplateTranslation
type: Class
title: EmailTemplateTranslation
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: emailType
  title: emailType
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: locale
  title: locale
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: subject
  title: subject
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: title
  title: title
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: body
  title: body
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: actionButtonText
  title: actionButtonText
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a EmailTemplateTranslation resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a EmailTemplateTranslation resource.
  returns: EmailTemplateTranslation
supported operation: Deletes the EmailTemplateTranslation resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the EmailTemplateTranslation resource.
  returns: Nothing

id
type: Property
domain: EmailTemplateTranslation
range: string

emailType
type: Property
domain: EmailTemplateTranslation

locale
type: Property
domain: EmailTemplateTranslation
range: string

subject
type: Property
domain: EmailTemplateTranslation
range: string

title
type: Property
domain: EmailTemplateTranslation
range: string

body
type: Property
domain: EmailTemplateTranslation
range: string

actionButtonText
type: Property
domain: EmailTemplateTranslation
range: string

StudyEmailTemplate
type: Class
title: StudyEmailTemplate
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: studyId
  title: studyId
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: emailTemplateId
  title: emailTemplateId
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: emailType
  title: emailType
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: studyEmailTemplateTranslations
  title: studyEmailTemplateTranslations
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a StudyEmailTemplate resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a StudyEmailTemplate resource.
  returns: StudyEmailTemplate
supported operation: Deletes the StudyEmailTemplate resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the StudyEmailTemplate resource.
  returns: Nothing

id
type: Property
domain: StudyEmailTemplate
range: string

studyId
type: Property
domain: StudyEmailTemplate
range: string

emailTemplateId
type: Property
domain: StudyEmailTemplate
range: string

emailType
type: Property
domain: StudyEmailTemplate

studyEmailTemplateTranslations
type: Property
domain: StudyEmailTemplate

ExternalSignatureRequest
type: Class
title: ExternalSignatureRequest
supported property: SupportedProperty
  property: subjectInformedConsentForm
  title: subjectInformedConsentForm
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: user
  title: user
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: activateTill
  title: activateTill
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: token
  title: token
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: isSigned
  title: isSigned
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: subjectInformedConsentForm
  title: subjectInformedConsentForm
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ssoSource
  title: ssoSource
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a ExternalSignatureRequest resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a ExternalSignatureRequest resource.
  returns: ExternalSignatureRequest

subjectInformedConsentForm
type: Link
domain: ExternalSignatureRequest
max cardinality: 1
range: SubjectInformedConsentForm

id
type: Property
domain: ExternalSignatureRequest
range: string

user
type: Link
domain: ExternalSignatureRequest
max cardinality: 1
range: User

createdAt
type: Property
domain: ExternalSignatureRequest
range: dateTime

activateTill
type: Property
domain: ExternalSignatureRequest
range: dateTime

token
type: Property
domain: ExternalSignatureRequest
range: string

isSigned
type: Property
domain: ExternalSignatureRequest
range: boolean

ssoSource
type: Property
domain: ExternalSignatureRequest
range: string

FeatureFlag
type: Class
title: FeatureFlag
supported property: SupportedProperty
  property: isEnabled
  title: isEnabled
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a FeatureFlag resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a FeatureFlag resource.
  returns: FeatureFlag

isEnabled
type: Property
domain: FeatureFlag
range: boolean

FormBlock
type: Class
title: FormBlock
supported property: SupportedProperty
  property: informedConsentForm
  title: informedConsentForm
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: type
  title: type
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: orderNr
  title: orderNr
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: label
  title: label
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: properties
  title: properties
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: isMandatory
  title: isMandatory
  required: false
  readable: true
  writeable: true
  description: This is here purely to make ApiPlatform happy.
supported property: SupportedProperty
  property: formBlockTarget
  title: formBlockTarget
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: subjectRelationships
  title: subjectRelationships
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: formBlockQuestion
  title: formBlockQuestion
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a FormBlock resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a FormBlock resource.
  returns: FormBlock
supported operation: Deletes the FormBlock resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the FormBlock resource.
  returns: Nothing
supported operation: Replaces the FormBlock resource.
  type: Operation
  type: ReplaceAction
  expects: FormBlock
  method: PUT
  title: Replaces the FormBlock resource.
  returns: FormBlock
supported operation: Updates the FormBlock resource.
  type: Operation
  expects: FormBlock
  method: PATCH
  title: Updates the FormBlock resource.
  returns: FormBlock

informedConsentForm
type: Link
domain: FormBlock
max cardinality: 1
range: InformedConsentForm

type
type: Property
domain: FormBlock

orderNr
type: Property
domain: FormBlock
range: integer

label
type: Property
domain: FormBlock
range: string

properties
type: Property
domain: FormBlock

isMandatory
type: Property
domain: FormBlock
range: boolean

formBlockTarget
type: Property
domain: FormBlock

subjectRelationships
type: Property
domain: FormBlock
range: SubjectRelationship

formBlockQuestion
type: Property
domain: FormBlock
max cardinality: 1
range: FormBlockQuestion

FormBlockAnswerOption
type: Class
title: FormBlockAnswerOption
supported property: SupportedProperty
  property: formBlockQuestion
  title: formBlockQuestion
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: answerText
  title: answerText
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: answerOptionType
  title: answerOptionType
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a FormBlockAnswerOption resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a FormBlockAnswerOption resource.
  returns: FormBlockAnswerOption

formBlockQuestion
type: Link
domain: FormBlockAnswerOption
max cardinality: 1
range: FormBlockQuestion

answerText
type: Property
domain: FormBlockAnswerOption
range: string

answerOptionType
type: Property
domain: FormBlockAnswerOption

FormBlockQuestion
type: Class
title: FormBlockQuestion
supported property: SupportedProperty
  property: type
  title: type
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: questionText
  title: questionText
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: formBlock
  title: formBlock
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: answerOptions
  title: answerOptions
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a FormBlockQuestion resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a FormBlockQuestion resource.
  returns: FormBlockQuestion

type
type: Property
domain: FormBlockQuestion

questionText
type: Property
domain: FormBlockQuestion
range: string

formBlock
type: Link
domain: FormBlockQuestion
max cardinality: 1
range: FormBlock

answerOptions
type: Link
domain: FormBlockQuestion
range: FormBlockAnswerOption

SubjectRelationship
type: Class
title: SubjectRelationship
supported property: SupportedProperty
  property: slug
  title: slug
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: fieldType
  title: fieldType
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: formBlock
  title: formBlock
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a SubjectRelationship resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a SubjectRelationship resource.
  returns: SubjectRelationship

slug
type: Property
domain: SubjectRelationship
range: string

fieldType
type: Property
domain: SubjectRelationship

name
type: Property
domain: SubjectRelationship
range: string

formBlock
type: Link
domain: SubjectRelationship
max cardinality: 1
range: FormBlock

InformedConsentForm
type: Class
title: InformedConsentForm
supported property: SupportedProperty
  property: study
  title: study
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: versionNumber
  title: versionNumber
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: versionDate
  title: versionDate
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: versionReference
  title: versionReference
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: pdfAddPageNumber
  title: pdfAddPageNumber
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: pdfAddStudyLogo
  title: pdfAddStudyLogo
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: pdfHeaderTemplate
  title: pdfHeaderTemplate
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: pdfFooterTemplate
  title: pdfFooterTemplate
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: informedConsentFormStatus
  title: informedConsentFormStatus
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: formBlocks
  title: formBlocks
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: informedConsentFormStudySites
  title: informedConsentFormStudySites
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: languageCode
  title: languageCode
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: localeCode
  title: localeCode
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: countries
  title: countries
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: pdf
  title: pdf
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: irbecApprovalDate
  title: irbecApprovalDate
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: translateLabels
  title: translateLabels
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: consentMethod
  title: consentMethod
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: paperTemplate
  title: paperTemplate
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: protocolVersion
  title: protocolVersion
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: editorType
  title: editorType
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: signatureType
  title: signatureType
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: versionDateString
  title: versionDateString
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: languageCodeAlpha2
  title: languageCodeAlpha2
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: irbecApprovalDateString
  title: irbecApprovalDateString
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: includedTypesOfSignatures
  title: includedTypesOfSignatures
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a InformedConsentForm resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a InformedConsentForm resource.
  returns: InformedConsentForm
supported operation: Replaces the InformedConsentForm resource.
  type: Operation
  type: ReplaceAction
  expects: InformedConsentForm
  method: PUT
  title: Replaces the InformedConsentForm resource.
  returns: InformedConsentForm
supported operation: Updates the InformedConsentForm resource.
  type: Operation
  expects: InformedConsentForm
  method: PATCH
  title: Updates the InformedConsentForm resource.
  returns: InformedConsentForm
supported operation: Retrieves a InformedConsentForm resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a InformedConsentForm resource.
  returns: InformedConsentForm
supported operation: Deletes the InformedConsentForm resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the InformedConsentForm resource.
  returns: Nothing

study
type: Link
domain: InformedConsentForm
max cardinality: 1
range: Study

name
type: Property
domain: InformedConsentForm
range: string

versionNumber
type: Property
domain: InformedConsentForm
range: string

versionDate
type: Property
domain: InformedConsentForm
range: dateTime

versionReference
type: Property
domain: InformedConsentForm
range: string

pdfAddPageNumber
type: Property
domain: InformedConsentForm
range: boolean

pdfAddStudyLogo
type: Property
domain: InformedConsentForm
range: boolean

pdfHeaderTemplate
type: Property
domain: InformedConsentForm
range: string

pdfFooterTemplate
type: Property
domain: InformedConsentForm
range: string

informedConsentFormStatus
type: Property
domain: InformedConsentForm

formBlocks
type: Property
domain: InformedConsentForm
range: FormBlock

informedConsentFormStudySites
type: Property
domain: InformedConsentForm
range: InformedConsentFormStudySite

languageCode
type: Property
domain: InformedConsentForm
deprecated: true
range: string

localeCode
type: Property
domain: InformedConsentForm
range: string

countries
type: Property
domain: InformedConsentForm
range: InformedConsentFormCountry

pdf
type: Property
domain: InformedConsentForm
max cardinality: 1
range: InformedConsentFormPdf

irbecApprovalDate
type: Property
domain: InformedConsentForm
range: dateTime

translateLabels
type: Property
domain: InformedConsentForm
range: boolean

consentMethod
type: Property
domain: InformedConsentForm

paperTemplate
type: Property
domain: InformedConsentForm
max cardinality: 1
range: PaperTemplate

protocolVersion
type: Property
domain: InformedConsentForm
range: string

editorType
type: Property
domain: InformedConsentForm

signatureType
type: Property
domain: InformedConsentForm

versionDateString
type: Property
domain: InformedConsentForm
range: string

languageCodeAlpha2
type: Property
domain: InformedConsentForm
deprecated: true
range: string

irbecApprovalDateString
type: Property
domain: InformedConsentForm
range: string

includedTypesOfSignatures
type: Property
domain: InformedConsentForm
range: string

InformedConsentFormCountry
type: Class
title: InformedConsentFormCountry
supported property: SupportedProperty
  property: informedConsentForm
  title: informedConsentForm
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: countryCode
  title: countryCode
  required: true
  readable: true
  writeable: true
supported operation: Retrieves a InformedConsentFormCountry resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a InformedConsentFormCountry resource.
  returns: InformedConsentFormCountry

informedConsentForm
type: Link
domain: InformedConsentFormCountry
max cardinality: 1
range: InformedConsentForm

countryCode
type: Property
domain: InformedConsentFormCountry
range: string

InformedConsentFormPdf
type: Class
title: InformedConsentFormPdf
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a InformedConsentFormPdf resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a InformedConsentFormPdf resource.
  returns: InformedConsentFormPdf
supported operation: Retrieves a InformedConsentFormPdf resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a InformedConsentFormPdf resource.
  returns: InformedConsentFormPdf
label: SubjectInformedConsentFormPdf
title: SubjectInformedConsentFormPdf
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a SubjectInformedConsentFormPdf resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a SubjectInformedConsentFormPdf resource.
  returns: InformedConsentFormPdf
supported operation: Retrieves a SubjectInformedConsentFormPdf resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a SubjectInformedConsentFormPdf resource.
  returns: InformedConsentFormPdf
supported operation: Retrieves a SubjectInformedConsentFormPdf resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a SubjectInformedConsentFormPdf resource.
  returns: InformedConsentFormPdf

status
type: Property
domain: InformedConsentFormPdf

InformedConsentFormStudySite
type: Class
title: InformedConsentFormStudySite
supported property: SupportedProperty
  property: informedConsentForm
  title: informedConsentForm
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: studySite
  title: studySite
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: defaultIcf
  title: defaultIcf
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a InformedConsentFormStudySite resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a InformedConsentFormStudySite resource.
  returns: InformedConsentFormStudySite

informedConsentForm
type: Link
domain: InformedConsentFormStudySite
max cardinality: 1
range: InformedConsentForm

studySite
type: Link
domain: InformedConsentFormStudySite
max cardinality: 1
range: StudySite

defaultIcf
type: Property
domain: InformedConsentFormStudySite
range: boolean

PaperTemplate
type: Class
title: PaperTemplate
supported property: SupportedProperty
  property: informedConsentForm
  title: informedConsentForm
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: file
  title: file
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: fileName
  title: fileName
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: originalFileName
  title: originalFileName
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: fileSize
  title: fileSize
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a PaperTemplate resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a PaperTemplate resource.
  returns: PaperTemplate

informedConsentForm
type: Link
domain: PaperTemplate
max cardinality: 1
range: InformedConsentForm

file
type: Property
domain: PaperTemplate

fileName
type: Property
domain: PaperTemplate
range: string

originalFileName
type: Property
domain: PaperTemplate
range: string

fileSize
type: Property
domain: PaperTemplate
range: integer

Language
type: Class
title: Language
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a Language resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Language resource.
  returns: Nothing

name
type: Property
domain: Language
range: string

Locale
type: Class
title: Locale
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a Locale resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Locale resource.
  returns: Locale

name
type: Property
domain: Locale
range: string

Organization
type: Class
title: Organization
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: abbreviation
  title: abbreviation
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: studies
  title: studies
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a Organization resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Organization resource.
  returns: Organization
supported operation: Replaces the Organization resource.
  type: Operation
  type: ReplaceAction
  expects: Organization
  method: PUT
  title: Replaces the Organization resource.
  returns: Organization
supported operation: Updates the Organization resource.
  type: Operation
  expects: Organization
  method: PATCH
  title: Updates the Organization resource.
  returns: Organization

name
type: Property
domain: Organization
range: string

abbreviation
type: Property
domain: Organization
range: string

studies
type: Link
domain: Organization
range: Study

Report
type: Class
title: Report
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: requestDate
  title: requestDate
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: reportType
  title: reportType
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: reportGenerationStatus
  title: reportGenerationStatus
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: study
  title: study
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: user
  title: user
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: progressPercentage
  title: progressPercentage
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: publicReportName
  title: publicReportName
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a Report resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Report resource.
  returns: Report
supported operation: Retrieves a Report resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Report resource.
  returns: Report

id
type: Property
domain: Report
range: string

requestDate
type: Property
domain: Report
range: dateTime

reportType
type: Property
domain: Report

reportGenerationStatus
type: Property
domain: Report

study
type: Link
domain: Report
max cardinality: 1
range: Study

user
type: Link
domain: Report
max cardinality: 1
range: User

progressPercentage
type: Property
domain: Report
range: integer

publicReportName
type: Property
domain: Report
range: string

Site
type: Class
title: Site
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: abbreviation
  title: abbreviation
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: countryCode
  title: countryCode
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: studySites
  title: studySites
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: countryCodeAlpha2
  title: countryCodeAlpha2
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: countryName
  title: countryName
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a Site resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Site resource.
  returns: Site
supported operation: Deletes the Site resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Site resource.
  returns: Nothing

name
type: Property
domain: Site
range: string

abbreviation
type: Property
domain: Site
range: string

countryCode
type: Property
domain: Site
range: string

studySites
type: Link
domain: Site
range: StudySite

countryCodeAlpha2
type: Property
domain: Site
range: string

countryName
type: Property
domain: Site
range: string

StudySiteRole
type: Class
title: StudySiteRole
supported property: SupportedProperty
  property: studySite
  title: studySite
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: user
  title: user
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: activatedDate
  title: activatedDate
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: roleType
  title: roleType
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: studyInvitation
  title: studyInvitation
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: study
  title: study
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a StudySiteRole resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a StudySiteRole resource.
  returns: StudySiteRole

studySite
type: Link
domain: StudySiteRole
max cardinality: 1
range: StudySite

user
type: Link
domain: StudySiteRole
max cardinality: 1
range: User

activatedDate
type: Property
domain: StudySiteRole
range: dateTime

roleType
type: Property
domain: StudySiteRole

studyInvitation
type: Link
domain: StudySiteRole
max cardinality: 1
range: StudyInvitation

study
type: Link
domain: StudySiteRole
max cardinality: 1
range: Study

StudySite
type: Class
title: StudySite
supported property: SupportedProperty
  property: study
  title: study
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: site
  title: site
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: subjects
  title: subjects
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: studySiteRoles
  title: studySiteRoles
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a StudySite resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a StudySite resource.
  returns: StudySite
supported operation: Replaces the StudySite resource.
  type: Operation
  type: ReplaceAction
  expects: StudySite
  method: PUT
  title: Replaces the StudySite resource.
  returns: StudySite
supported operation: Updates the StudySite resource.
  type: Operation
  expects: StudySite
  method: PATCH
  title: Updates the StudySite resource.
  returns: StudySite

study
type: Property
domain: StudySite
max cardinality: 1
range: Study

site
type: Property
domain: StudySite
max cardinality: 1
range: Site

subjects
type: Link
domain: StudySite
range: Subject

studySiteRoles
type: Link
domain: StudySite
range: StudySiteRole

Integration
type: Class
title: Integration
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: mapping
  title: mapping
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: eConsentStudyId
  title: eConsentStudyId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: edcStudyId
  title: edcStudyId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: edcStudySlug
  title: edcStudySlug
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: integrationType
  title: integrationType
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: edcApiCredentials
  title: edcApiCredentials
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: surveyName
  title: surveyName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: triggerType
  title: triggerType
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: studyIntegrationSettingEDCId
  title: studyIntegrationSettingEDCId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: onSiteEproModeEnabled
  title: onSiteEproModeEnabled
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: eproStudyLink
  title: eproStudyLink
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a Integration resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Integration resource.
  returns: Integration
supported operation: Updates the Integration resource.
  type: Operation
  expects: Integration
  method: PATCH
  title: Updates the Integration resource.
  returns: Integration

id
type: Property
domain: Integration
range: string

mapping
type: Property
domain: Integration

eConsentStudyId
type: Property
domain: Integration
range: string

edcStudyId
type: Property
domain: Integration
range: string

edcStudySlug
type: Property
domain: Integration
range: string

integrationType
type: Property
domain: Integration
range: string

edcApiCredentials
type: Property
domain: Integration

surveyName
type: Property
domain: Integration
range: string

triggerType
type: Property
domain: Integration
range: string

studyIntegrationSettingEDCId
type: Property
domain: Integration
range: string

onSiteEproModeEnabled
type: Property
domain: Integration
range: boolean

eproStudyLink
type: Property
domain: Integration
range: string

StudyIntegration
type: Class
title: StudyIntegration
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: integrationCollection
  title: integrationCollection
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a StudyIntegration resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a StudyIntegration resource.
  returns: StudyIntegration
supported operation: Deletes the StudyIntegration resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the StudyIntegration resource.
  returns: Nothing
supported operation: Retrieves a StudyIntegration resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a StudyIntegration resource.
  returns: StudyIntegration

id
type: Property
domain: StudyIntegration
range: string

integrationCollection
type: Property
domain: StudyIntegration
range: Integration

StudyInvitation
type: Class
title: StudyInvitation
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: invitedOn
  title: invitedOn
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: user
  title: user
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: study
  title: study
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a StudyInvitation resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a StudyInvitation resource.
  returns: StudyInvitation
supported operation: Deletes the StudyInvitation resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the StudyInvitation resource.
  returns: Nothing
supported operation: Replaces the StudyInvitation resource.
  type: Operation
  type: ReplaceAction
  expects: StudyInvitation
  method: PUT
  title: Replaces the StudyInvitation resource.
  returns: StudyInvitation
supported operation: Replaces the StudyInvitation resource.
  type: Operation
  type: ReplaceAction
  expects: StudyInvitation
  method: PUT
  title: Replaces the StudyInvitation resource.
  returns: StudyInvitation

status
type: Property
domain: StudyInvitation

invitedOn
type: Property
domain: StudyInvitation
range: dateTime

user
type: Link
domain: StudyInvitation
max cardinality: 1
range: User

study
type: Property
domain: StudyInvitation
max cardinality: 1
range: Study

StudyRole
type: Class
title: StudyRole
supported property: SupportedProperty
  property: study
  title: study
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: user
  title: user
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: activatedDate
  title: activatedDate
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: roleType
  title: roleType
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: studyInvitation
  title: studyInvitation
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a StudyRole resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a StudyRole resource.
  returns: StudyRole

study
type: Link
domain: StudyRole
max cardinality: 1
range: Study

user
type: Link
domain: StudyRole
max cardinality: 1
range: User

activatedDate
type: Property
domain: StudyRole
range: dateTime

roleType
type: Property
domain: StudyRole

studyInvitation
type: Link
domain: StudyRole
max cardinality: 1
range: StudyInvitation

Study
type: Class
title: Study
supported property: SupportedProperty
  property: userRightsAreBeingCalculated
  title: userRightsAreBeingCalculated
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: introductionVideoUrl
  title: introductionVideoUrl
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: description
  title: description
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: contactDetails
  title: contactDetails
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: studyLogo
  title: studyLogo
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: organization
  title: organization
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: roles
  title: roles
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: studySites
  title: studySites
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: videoCallSubjectAccessType
  title: videoCallSubjectAccessType
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: mainContactPerson
  title: mainContactPerson
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: userType
  title: userType
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: currentUserRights
  title: currentUserRights
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: subjectId
  title: subjectId
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: studyConsentSetting
  title: studyConsentSetting
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: screeningIdSetting
  title: screeningIdSetting
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: studyIntegrationSetting
  title: studyIntegrationSetting
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: subjectPersonalDetailsFieldsSetting
  title: subjectPersonalDetailsFieldsSetting
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: studyAdmins
  title: studyAdmins
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: userRightsAreBeingCalculated
  title: userRightsAreBeingCalculated
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: introductionVideoUrl
  title: introductionVideoUrl
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: withdrawalSetting
  title: withdrawalSetting
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: studySetting
  title: studySetting
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a Study resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Study resource.
  returns: Study
supported operation: Replaces the Study resource.
  type: Operation
  type: ReplaceAction
  expects: Study
  method: PUT
  title: Replaces the Study resource.
  returns: Study
supported operation: Updates the Study resource.
  type: Operation
  expects: Study
  method: PATCH
  title: Updates the Study resource.
  returns: Study
supported operation: Replaces the Study resource.
  type: Operation
  type: ReplaceAction
  expects: Study
  method: PUT
  title: Replaces the Study resource.
  returns: Study
supported operation: Deletes the Study resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Study resource.
  returns: Nothing

userRightsAreBeingCalculated
type: Property
domain: Study
range: boolean

introductionVideoUrl
type: Property
domain: Study
range: string

id
type: Property
domain: Study
range: string

name
type: Property
domain: Study
range: string

description
type: Property
domain: Study
range: string

contactDetails
type: Property
domain: Study
range: string

studyLogo
type: Link
domain: Study
max cardinality: 1
range: StudyLogo

organization
type: Property
domain: Study
max cardinality: 1
range: Organization

roles
type: Property
domain: Study
deprecated: true
range: StudyRole

studySites
type: Property
domain: Study
range: StudySite

videoCallSubjectAccessType
type: Property
domain: Study

status
type: Property
domain: Study

mainContactPerson
type: Property
domain: Study
max cardinality: 1
range: User

userType
type: Property
domain: Study
range: string

currentUserRights
type: Property
domain: Study
range: string

subjectId
type: Property
domain: Study
range: string

studyConsentSetting
type: Property
domain: Study

screeningIdSetting
type: Property
domain: Study

studyIntegrationSetting
type: Property
domain: Study

subjectPersonalDetailsFieldsSetting
type: Property
domain: Study

studyAdmins
type: Property
domain: Study
range: User

withdrawalSetting
type: Property
domain: Study
max cardinality: 1
range: StudyWithdrawalSetting

studySetting
type: Property
domain: Study

StudyLogo
type: Class
title: StudyLogo
supported property: SupportedProperty
  property: fileName
  title: fileName
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: availableSizes
  title: availableSizes
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a StudyLogo resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a StudyLogo resource.
  returns: StudyLogo

fileName
type: Property
domain: StudyLogo
range: string

availableSizes
type: Property
domain: StudyLogo
range: string

StudyWithdrawalSetting
type: Class
title: StudyWithdrawalSetting
supported property: SupportedProperty
  property: enabled
  title: enabled
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: reasons
  title: reasons
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a StudyWithdrawalSetting resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a StudyWithdrawalSetting resource.
  returns: Nothing
supported operation: Replaces the StudyWithdrawalSetting resource.
  type: Operation
  type: ReplaceAction
  expects: StudyWithdrawalSetting
  method: PUT
  title: Replaces the StudyWithdrawalSetting resource.
  returns: StudyWithdrawalSetting

enabled
type: Property
domain: StudyWithdrawalSetting
range: boolean

reasons
type: Property
domain: StudyWithdrawalSetting

SubjectRole
type: Class
title: SubjectRole
supported property: SupportedProperty
  property: subject
  title: subject
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: user
  title: user
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: roleType
  title: roleType
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: studyInvitationSendType
  title: studyInvitationSendType
  required: false
  readable: false
  writeable: true
supported operation: Retrieves a SubjectRole resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a SubjectRole resource.
  returns: SubjectRole

subject
type: Link
domain: SubjectRole
max cardinality: 1
range: Subject

user
type: Property
domain: SubjectRole
max cardinality: 1
range: User

roleType
type: Property
domain: SubjectRole

studyInvitationSendType
type: Property
domain: SubjectRole

Subject
type: Class
title: Subject
supported property: SupportedProperty
  property: screeningId
  title: screeningId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: language
  title: language
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: locale
  title: locale
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: roles
  title: roles
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: consentForms
  title: consentForms
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: studySite
  title: studySite
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: archive
  title: archive
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: subjectProfile
  title: subjectProfile
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: profileStatus
  title: profileStatus
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: currentUserRights
  title: currentUserRights
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: studyInvitationSendType
  title: studyInvitationSendType
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: subjectIdentifier
  title: subjectIdentifier
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: createdBy
  title: createdBy
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: eligibilityStatus
  title: eligibilityStatus
  required: true
  readable: true
  writeable: false
supported property: SupportedProperty
  property: eligibilityStatusUpdatedOn
  title: eligibilityStatusUpdatedOn
  required: true
  readable: true
  writeable: false
supported property: SupportedProperty
  property: screeningIdIsBeingGenerated
  title: screeningIdIsBeingGenerated
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: wechatQrCompleted
  title: wechatQrCompleted
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: expediteScreeningIdGeneration
  title: expediteScreeningIdGeneration
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: subjectAppointments
  title: subjectAppointments
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdOn
  title: createdOn
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: withdrawal
  title: withdrawal
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: externalLinks
  title: externalLinks
  required: false
  readable: true
  writeable: true
  description: Represents externals links to external systems such as CDMS.
supported property: SupportedProperty
  property: studyInvitation
  title: studyInvitation
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: consentStatus
  title: consentStatus
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: consentedOn
  title: consentedOn
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: lastConsentedIcfVersionNumber
  title: lastConsentedIcfVersionNumber
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: lastConsentedIcfVersionDate
  title: lastConsentedIcfVersionDate
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: studyInvitationOfParticipant
  title: studyInvitationOfParticipant
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: screeningIdExternalLink
  title: screeningIdExternalLink
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: subjectIdExternalLink
  title: subjectIdExternalLink
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a Subject resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Subject resource.
  returns: Subject
supported operation: Replaces the Subject resource.
  type: Operation
  type: ReplaceAction
  expects: Subject
  method: PUT
  title: Replaces the Subject resource.
  returns: Subject
supported operation: Replaces the Subject resource.
  type: Operation
  type: ReplaceAction
  expects: Subject
  method: PUT
  title: Replaces the Subject resource.
  returns: Subject
supported operation: Updates the Subject resource.

screeningId
type: Property
domain: Subject
range: string

language
type: Property
domain: Subject
deprecated: true
range: string

locale
type: Property
domain: Subject
range: string

roles
type: Property
domain: Subject
range: SubjectRole

consentForms
type: Property
domain: Subject
range: SubjectInformedConsentForm

studySite
type: Property
domain: Subject
max cardinality: 1
range: StudySite

archive
type: Property
domain: Subject
range: boolean

subjectProfile
type: Property
domain: Subject
max cardinality: 1
range: SubjectProfile

profileStatus
type: Property
domain: Subject

currentUserRights
type: Property
domain: Subject
range: string

studyInvitationSendType
type: Property
domain: Subject

subjectIdentifier
type: Property
domain: Subject
range: string

createdBy
type: Property
domain: Subject
max cardinality: 1
range: User

eligibilityStatus
type: Property
domain: Subject

eligibilityStatusUpdatedOn
type: Property
domain: Subject
range: dateTime

screeningIdIsBeingGenerated
type: Property
domain: Subject
range: boolean

wechatQrCompleted
type: Property
domain: Subject
range: boolean

expediteScreeningIdGeneration
type: Property
domain: Subject
range: boolean

subjectAppointments
type: Property
domain: Subject

createdOn
type: Property
domain: Subject
range: dateTime

withdrawal
type: Property
domain: Subject

externalLinks
type: Property
domain: Subject
range: string

studyInvitation
type: Property
domain: Subject
max cardinality: 1
range: StudyInvitation

consentStatus
type: Property
domain: Subject

consentedOn
type: Property
domain: Subject
range: dateTime

lastConsentedIcfVersionNumber
type: Property
domain: Subject
range: string

lastConsentedIcfVersionDate
type: Property
domain: Subject
range: dateTime

studyInvitationOfParticipant
type: Property
domain: Subject
max cardinality: 1
range: StudyInvitation

screeningIdExternalLink
type: Property
domain: Subject
range: string

subjectIdExternalLink
type: Property
domain: Subject
range: string

SubjectFormBlock
type: Class
title: SubjectFormBlock
supported property: SupportedProperty
  property: subjectInformedConsentForm
  title: subjectInformedConsentForm
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: formBlock
  title: formBlock
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: subjectFormBlockValue
  title: subjectFormBlockValue
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: invitedSigner
  title: invitedSigner
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: activationStatus
  title: activationStatus
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: subjectQuestion
  title: subjectQuestion
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: isSigned
  title: isSigned
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: subjectSignatureActivatedAndSigned
  title: subjectSignatureActivatedAndSigned
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: activationStatusAuditTrailEventType
  title: activationStatusAuditTrailEventType
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: study
  title: study
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: notMandatoryQuestion
  title: notMandatoryQuestion
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: subjectOrLARSignature
  title: subjectOrLARSignature
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a SubjectFormBlock resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a SubjectFormBlock resource.
  returns: SubjectFormBlock
supported operation: Updates the SubjectFormBlock resource.
  type: Operation
  expects: SubjectFormBlock
  method: PATCH
  title: Updates the SubjectFormBlock resource.
  returns: SubjectFormBlock

subjectInformedConsentForm
type: Link
domain: SubjectFormBlock
max cardinality: 1
range: SubjectInformedConsentForm

formBlock
type: Link
domain: SubjectFormBlock
max cardinality: 1
range: FormBlock

subjectFormBlockValue
type: Link
domain: SubjectFormBlock
max cardinality: 1
range: SubjectFormBlockValue

invitedSigner
type: Link
domain: SubjectFormBlock
max cardinality: 1
range: InviteSigner

activationStatus
type: Property
domain: SubjectFormBlock

subjectQuestion
type: Property
domain: SubjectFormBlock
range: boolean

isSigned
type: Property
domain: SubjectFormBlock
range: boolean

subjectSignatureActivatedAndSigned
type: Property
domain: SubjectFormBlock
range: boolean

activationStatusAuditTrailEventType
type: Property
domain: SubjectFormBlock

study
type: Link
domain: SubjectFormBlock
max cardinality: 1
range: Study

notMandatoryQuestion
type: Property
domain: SubjectFormBlock
range: boolean

subjectOrLARSignature
type: Property
domain: SubjectFormBlock
range: boolean

SubjectFormBlockAnswer
type: Class
title: SubjectFormBlockAnswer
supported property: SupportedProperty
  property: subjectFormBlockValue
  title: subjectFormBlockValue
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: formBlockAnswerOption
  title: formBlockAnswerOption
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: answerText
  title: answerText
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: question
  title: question
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a SubjectFormBlockAnswer resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a SubjectFormBlockAnswer resource.
  returns: SubjectFormBlockAnswer

subjectFormBlockValue
type: Link
domain: SubjectFormBlockAnswer
max cardinality: 1
range: SubjectFormBlockValue

formBlockAnswerOption
type: Link
domain: SubjectFormBlockAnswer
max cardinality: 1
range: FormBlockAnswerOption

answerText
type: Property
domain: SubjectFormBlockAnswer
range: string

question
type: Property
domain: SubjectFormBlockAnswer
range: string

SubjectFormBlockValue
type: Class
title: SubjectFormBlockValue
supported property: SupportedProperty
  property: data
  title: data
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: signedOn
  title: signedOn
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: user
  title: user
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: subjectFormBlock
  title: subjectFormBlock
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: valueChanged
  title: valueChanged
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: formattedSignedDate
  title: formattedSignedDate
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: answers
  title: answers
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: target
  title: target
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: valid
  title: valid
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: decodedJsonData
  title: decodedJsonData
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: jsonDataAsArray
  title: jsonDataAsArray
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: timeZoneNameAbbreviated
  title: timeZoneNameAbbreviated
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: timezone
  title: timezone
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: selectedAnswerOptions
  title: selectedAnswerOptions
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: answersSelected
  title: answersSelected
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: signatureFullName
  title: signatureFullName
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: consentingOnBehalfOf
  title: consentingOnBehalfOf
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: relationship
  title: relationship
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: signatureEmail
  title: signatureEmail
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: lAREmail
  title: lAREmail
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: pIIRemoved
  title: pIIRemoved
  required: false
  readable: false
  writeable: false
supported operation: Retrieves a SubjectFormBlockValue resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a SubjectFormBlockValue resource.
  returns: SubjectFormBlockValue

data
type: Property
domain: SubjectFormBlockValue
range: string

signedOn
type: Property
domain: SubjectFormBlockValue
range: dateTime

user
type: Link
domain: SubjectFormBlockValue
max cardinality: 1
range: User

subjectFormBlock
type: Link
domain: SubjectFormBlockValue
max cardinality: 1
range: SubjectFormBlock

valueChanged
type: Property
domain: SubjectFormBlockValue
range: boolean

formattedSignedDate
type: Property
domain: SubjectFormBlockValue
range: string

answers
type: Link
domain: SubjectFormBlockValue
range: SubjectFormBlockAnswer

target
type: Property
domain: SubjectFormBlockValue

valid
type: Property
domain: SubjectFormBlockValue
range: boolean

decodedJsonData
type: Property
domain: SubjectFormBlockValue
range: boolean

jsonDataAsArray
type: Property
domain: SubjectFormBlockValue

timeZoneNameAbbreviated
type: Property
domain: SubjectFormBlockValue
range: string

timezone
type: Property
domain: SubjectFormBlockValue

selectedAnswerOptions
type: Property
domain: SubjectFormBlockValue
range: boolean

answersSelected
type: Property
domain: SubjectFormBlockValue
range: string

signatureFullName
type: Property
domain: SubjectFormBlockValue
range: string

consentingOnBehalfOf
type: Property
domain: SubjectFormBlockValue
range: string

relationship
type: Property
domain: SubjectFormBlockValue
range: string

signatureEmail
type: Property
domain: SubjectFormBlockValue
range: string

lAREmail
type: Property
domain: SubjectFormBlockValue
range: string

pIIRemoved
type: Property
domain: SubjectFormBlockValue
range: boolean

SubjectInformedConsentForm
type: Class
title: SubjectInformedConsentForm
supported property: SupportedProperty
  property: form
  title: form
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: subject
  title: subject
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: subjectFormBlocks
  title: subjectFormBlocks
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: consentStatus
  title: consentStatus
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: readOnly
  title: readOnly
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: invitedOn
  title: invitedOn
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: consentedOn
  title: consentedOn
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: subjectRole
  title: subjectRole
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: pdf
  title: pdf
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: studyInvitationSendType
  title: studyInvitationSendType
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: canBeRemoved
  title: canBeRemoved
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: identityConfirmed
  title: identityConfirmed
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: identityLastConfirmedOn
  title: identityLastConfirmedOn
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: activateLARSignature
  title: activateLARSignature
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: paperSignedFile
  title: paperSignedFile
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a SubjectInformedConsentForm resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a SubjectInformedConsentForm resource.
  returns: SubjectInformedConsentForm
supported operation: Updates the SubjectInformedConsentForm resource.
  type: Operation
  expects: SubjectInformedConsentForm
  method: PATCH
  title: Updates the SubjectInformedConsentForm resource.
  returns: SubjectInformedConsentForm
supported operation: Replaces the SubjectInformedConsentForm resource.
  type: Operation
  type: ReplaceAction
  expects: SubjectInformedConsentForm
  method: PUT
  title: Replaces the SubjectInformedConsentForm resource.
  returns: SubjectInformedConsentForm
supported operation: Deletes the SubjectInformedConsentForm resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the SubjectInformedConsentForm resource.
  returns: Nothing
supported operation: Replaces the SubjectInformedConsentForm resource.
  type: Operation
  type: ReplaceAction
  expects: SubjectInformedConsentForm
  method: PUT
  title: Replaces the SubjectInformedConsentForm resource.
  returns: SubjectInformedConsentForm
supported operation: Replaces the SubjectInformedConsentForm resource.
  type: Operation
  type: ReplaceAction
  expects: SubjectInformedConsentForm
  method: PUT
  title: Replaces the SubjectInformedConsentForm resource.
  returns: SubjectInformedConsentForm
supported operation: Replaces the SubjectInformedConsentForm resource.
  type: Operation
  type: ReplaceAction
  expects: SubjectInformedConsentForm
  method: PUT
  title: Replaces the SubjectInformedConsentForm resource.
  returns: SubjectInformedConsentForm

form
type: Property
domain: SubjectInformedConsentForm
max cardinality: 1
range: InformedConsentForm

subject
type: Link
domain: SubjectInformedConsentForm
max cardinality: 1
range: Subject

subjectFormBlocks
type: Property
domain: SubjectInformedConsentForm
range: SubjectFormBlock

consentStatus
type: Property
domain: SubjectInformedConsentForm

readOnly
type: Property
domain: SubjectInformedConsentForm
range: boolean

invitedOn
type: Property
domain: SubjectInformedConsentForm
range: dateTime

consentedOn
type: Property
domain: SubjectInformedConsentForm
range: dateTime

subjectRole
type: Link
domain: SubjectInformedConsentForm
max cardinality: 1
range: SubjectRole

pdf
type: Property
domain: SubjectInformedConsentForm
max cardinality: 1
range: InformedConsentFormPdf

studyInvitationSendType
type: Property
domain: SubjectInformedConsentForm

canBeRemoved
type: Property
domain: SubjectInformedConsentForm
range: boolean

identityConfirmed
type: Property
domain: SubjectInformedConsentForm
range: boolean

identityLastConfirmedOn
type: Property
domain: SubjectInformedConsentForm
range: dateTime

activateLARSignature
type: Property
domain: SubjectInformedConsentForm
range: boolean

paperSignedFile
type: Property
domain: SubjectInformedConsentForm
max cardinality: 1
range: PaperSignedFile

status
type: Property
domain: InformedConsentFormPdf

InPersonSigningLock
type: Class
title: InPersonSigningLock
supported property: SupportedProperty
  property: isLocked
  title: isLocked
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: studyId
  title: studyId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: message
  title: message
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: study
  title: study
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a InPersonSigningLock resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a InPersonSigningLock resource.
  returns: InPersonSigningLock
supported operation: Deletes the InPersonSigningLock resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the InPersonSigningLock resource.
  returns: Nothing

isLocked
type: Property
domain: InPersonSigningLock
range: boolean

studyId
type: Property
domain: InPersonSigningLock
range: string

message
type: Property
domain: InPersonSigningLock
range: string

study
type: Link
domain: InPersonSigningLock
max cardinality: 1
range: Study

InviteSigner
type: Class
title: InviteSigner
supported property: SupportedProperty
  property: signer
  title: signer
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: subjectFormBlock
  title: subjectFormBlock
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: subjectInformedConsentForm
  title: subjectInformedConsentForm
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a InviteSigner resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a InviteSigner resource.
  returns: InviteSigner

signer
type: Link
domain: InviteSigner
max cardinality: 1
range: Signer

subjectFormBlock
type: Link
domain: InviteSigner
max cardinality: 1
range: SubjectFormBlock

subjectInformedConsentForm
type: Link
domain: InviteSigner
max cardinality: 1
range: SubjectInformedConsentForm

PaperSignedFile
type: Class
title: PaperSignedFile
supported property: SupportedProperty
  property: subjectInformedConsentForm
  title: subjectInformedConsentForm
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: file
  title: file
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a PaperSignedFile resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a PaperSignedFile resource.
  returns: PaperSignedFile
supported operation: Replaces the PaperSignedFile resource.
  type: Operation
  type: ReplaceAction
  expects: PaperSignedFile
  method: PUT
  title: Replaces the PaperSignedFile resource.
  returns: PaperSignedFile
supported operation: Deletes the PaperSignedFile resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the PaperSignedFile resource.
  returns: Nothing

subjectInformedConsentForm
type: Link
domain: PaperSignedFile
max cardinality: 1
range: SubjectInformedConsentForm

file
type: Property
domain: PaperSignedFile

Signer
type: Class
title: Signer
supported property: SupportedProperty
  property: email
  title: email
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a Signer resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Signer resource.
  returns: Signer

email
type: Property
domain: Signer
range: string

SubjectProfile
type: Class
title: SubjectProfile
supported property: SupportedProperty
  property: firstName
  title: firstName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: lastName
  title: lastName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: birthdate
  title: birthdate
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: gender
  title: gender
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: email
  title: email
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: phoneNumber
  title: phoneNumber
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: streetNameAndNumber
  title: streetNameAndNumber
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: addition
  title: addition
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: postCode
  title: postCode
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: city
  title: city
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: region
  title: region
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: country
  title: country
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a SubjectProfile resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a SubjectProfile resource.
  returns: SubjectProfile
supported operation: Updates the SubjectProfile resource.
  type: Operation
  expects: SubjectProfile
  method: PATCH
  title: Updates the SubjectProfile resource.
  returns: SubjectProfile
supported operation: Replaces the SubjectProfile resource.
  type: Operation
  type: ReplaceAction
  expects: SubjectProfile
  method: PUT
  title: Replaces the SubjectProfile resource.
  returns: SubjectProfile
supported operation: Retrieves a SubjectProfile resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a SubjectProfile resource.
  returns: SubjectProfile

firstName
type: Property
domain: SubjectProfile
range: string

lastName
type: Property
domain: SubjectProfile
range: string

birthdate
type: Property
domain: SubjectProfile
range: string

gender
type: Property
domain: SubjectProfile
range: string

email
type: Property
domain: SubjectProfile
range: string

phoneNumber
type: Property
domain: SubjectProfile
range: string

streetNameAndNumber
type: Property
domain: SubjectProfile
range: string

addition
type: Property
domain: SubjectProfile
range: string

postCode
type: Property
domain: SubjectProfile
range: string

city
type: Property
domain: SubjectProfile
range: string

region
type: Property
domain: SubjectProfile
range: string

country
type: Property
domain: SubjectProfile
range: string

SubjectVideoCall
type: Class
title: SubjectVideoCall
supported property: SupportedProperty
  property: videoTokenIdentifier
  title: videoTokenIdentifier
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: subjectInformedConsentForms
  title: subjectInformedConsentForms
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: startedOn
  title: startedOn
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: subjectJoinedOn
  title: subjectJoinedOn
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: endedOn
  title: endedOn
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a SubjectVideoCall resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a SubjectVideoCall resource.
  returns: SubjectVideoCall
supported operation: Updates the SubjectVideoCall resource.
  type: Operation
  expects: SubjectVideoCall
  method: PATCH
  title: Updates the SubjectVideoCall resource.
  returns: SubjectVideoCall

videoTokenIdentifier
type: Property
domain: SubjectVideoCall
range: string

subjectInformedConsentForms
type: Property
domain: SubjectVideoCall
range: SubjectInformedConsentForm

status
type: Property
domain: SubjectVideoCall

startedOn
type: Property
domain: SubjectVideoCall
range: dateTime

subjectJoinedOn
type: Property
domain: SubjectVideoCall
range: dateTime

endedOn
type: Property
domain: SubjectVideoCall
range: dateTime

User
type: Class
title: User
supported property: SupportedProperty
  property: email
  title: email
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: idpUserId
  title: idpUserId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: firstName
  title: firstName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: lastName
  title: lastName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: studyRoles
  title: studyRoles
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: studySiteRoles
  title: studySiteRoles
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: locale
  title: locale
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: studyInvitations
  title: studyInvitations
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: has2faConfigured
  title: has2faConfigured
  required: false
  readable: true
  writeable: true
  description: Only set to true or false when retrieving current user.
supported operation: Retrieves a User resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a User resource.
  returns: User
supported operation: Updates the User resource.
  type: Operation
  expects: User
  method: PATCH
  title: Updates the User resource.
  returns: User

email
type: Property
domain: User
range: string

idpUserId
type: Property
domain: User
range: string

firstName
type: Property
domain: User
range: string

lastName
type: Property
domain: User
range: string

studyRoles
type: Property
domain: User
range: StudyRole

studySiteRoles
type: Property
domain: User
range: StudySiteRole

locale
type: Property
domain: User
range: string

studyInvitations
type: Property
domain: User
range: StudyInvitation

has2faConfigured
type: Property
domain: User
range: boolean

VideoCallToken
type: Class
title: VideoCallToken
supported property: SupportedProperty
  property: subjectInformedConsentFormIds
  title: subjectInformedConsentFormIds
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: token
  title: token
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: subjectId
  title: subjectId
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: videoCallIdentifier
  title: videoCallIdentifier
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a VideoCallToken resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a VideoCallToken resource.
  returns: VideoCallToken

subjectInformedConsentFormIds
type: Property
domain: VideoCallToken
range: string

token
type: Property
domain: VideoCallToken
range: string

subjectId
type: Property
domain: VideoCallToken
range: string

videoCallIdentifier
type: Property
domain: VideoCallToken
range: string

Webhook
type: Class
title: Webhook
supported property: SupportedProperty
  property: study
  title: study
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: resource
  title: resource
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: supportedMethodType
  title: supportedMethodType
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: webhookUrl
  title: webhookUrl
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: publicKey
  title: publicKey
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: encryptResponse
  title: encryptResponse
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a Webhook resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Webhook resource.
  returns: Webhook
supported operation: Updates the Webhook resource.
  type: Operation
  expects: Webhook
  method: PATCH
  title: Updates the Webhook resource.
  returns: Webhook
supported operation: Replaces the Webhook resource.
  type: Operation
  type: ReplaceAction
  expects: Webhook
  method: PUT
  title: Replaces the Webhook resource.
  returns: Webhook
supported operation: Deletes the Webhook resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Webhook resource.
  returns: Nothing

study
type: Link
domain: Webhook
max cardinality: 1
range: Study

resource
type: Property
domain: Webhook
range: string

supportedMethodType
type: Property
domain: Webhook

webhookUrl
type: Property
domain: Webhook
range: string

publicKey
type: Property
domain: Webhook
range: string

encryptResponse
type: Property
domain: Webhook
range: boolean

Entrypoint
type: Class
title: The API entrypoint
supported property: SupportedProperty
  property: The collection of AuditTrail resources
  title: The collection of AuditTrail resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Country resources
  title: The collection of Country resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of EmailTemplate resources
  title: The collection of EmailTemplate resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of EmailTemplateTranslation resources
  title: The collection of EmailTemplateTranslation resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of StudyEmailTemplate resources
  title: The collection of StudyEmailTemplate resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of ExternalSignatureRequest resources
  title: The collection of ExternalSignatureRequest resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of FeatureFlag resources
  title: The collection of FeatureFlag resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of FormBlock resources
  title: The collection of FormBlock resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of SubjectRelationship resources
  title: The collection of SubjectRelationship resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of InformedConsentForm resources
  title: The collection of InformedConsentForm resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of InformedConsentFormPdf resources
  title: The collection of InformedConsentFormPdf resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Language resources
  title: The collection of Language resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Locale resources
  title: The collection of Locale resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Organization resources
  title: The collection of Organization resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Report resources
  title: The collection of Report resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Site resources
  title: The collection of Site resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of StudySite resources
  title: The collection of StudySite resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Integration resources
  title: The collection of Integration resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of StudyInvitation resources
  title: The collection of StudyInvitation resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Study resources
  title: The collection of Study resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of StudyWithdrawalSetting resources
  title: The collection of StudyWithdrawalSetting resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Subject resources
  title: The collection of Subject resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of SubjectFormBlockAnswer resources
  title: The collection of SubjectFormBlockAnswer resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of SubjectInformedConsentForm resources
  title: The collection of SubjectInformedConsentForm resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of SubjectInformedConsentFormPdf resources
  title: The collection of SubjectInformedConsentFormPdf resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of InPersonSigningLock resources
  title: The collection of InPersonSigningLock resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Signer resources
  title: The collection of Signer resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of SubjectVideoCall resources
  title: The collection of SubjectVideoCall resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of User resources
  title: The collection of User resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of VideoCallToken resources
  title: The collection of VideoCallToken resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Webhook resources
  title: The collection of Webhook resources
  readable: true
  writeable: false
supported operation: The API entrypoint.
  type: Operation
  method: GET
  returns: EntryPoint

The collection of AuditTrail resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: AuditTrail
supported operation: Retrieves the collection of AuditTrail resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of AuditTrail resources.
  deprecated: true
  returns: Collection
supported operation: Retrieves the collection of AuditTrail resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of AuditTrail resources.
  returns: Collection

The collection of Country resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Country
supported operation: Retrieves the collection of Country resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Country resources.
  returns: Collection

The collection of EmailTemplate resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: EmailTemplate
supported operation: Retrieves the collection of EmailTemplate resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of EmailTemplate resources.
  returns: Collection
supported operation: Creates a EmailTemplate resource.
  type: Operation
  type: CreateAction
  expects: EmailTemplate
  method: POST
  title: Creates a EmailTemplate resource.
  returns: EmailTemplate

The collection of EmailTemplateTranslation resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: EmailTemplateTranslation
supported operation: Retrieves the collection of EmailTemplateTranslation resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of EmailTemplateTranslation resources.
  returns: Collection
supported operation: Creates a EmailTemplateTranslation resource.
  type: Operation
  type: CreateAction
  expects: EmailTemplateTranslation
  method: POST
  title: Creates a EmailTemplateTranslation resource.
  returns: EmailTemplateTranslation

The collection of StudyEmailTemplate resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: StudyEmailTemplate
supported operation: Retrieves the collection of StudyEmailTemplate resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of StudyEmailTemplate resources.
  returns: Collection
supported operation: Creates a StudyEmailTemplate resource.
  type: Operation
  type: CreateAction
  expects: StudyEmailTemplate
  method: POST
  title: Creates a StudyEmailTemplate resource.
  returns: StudyEmailTemplate

The collection of ExternalSignatureRequest resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: ExternalSignatureRequest
supported operation: Retrieves the collection of ExternalSignatureRequest resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ExternalSignatureRequest resources.
  returns: Collection
supported operation: Creates a ExternalSignatureRequest resource.
  type: Operation
  type: CreateAction
  expects: ExternalSignatureRequest
  method: POST
  title: Creates a ExternalSignatureRequest resource.
  returns: ExternalSignatureRequest

The collection of FeatureFlag resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: FeatureFlag
supported operation: Retrieves the collection of FeatureFlag resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of FeatureFlag resources.
  returns: Collection

The collection of FormBlock resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: FormBlock
supported operation: Retrieves the collection of FormBlock resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of FormBlock resources.
  returns: Collection
supported operation: Creates a FormBlock resource.
  type: Operation
  type: CreateAction
  expects: FormBlock
  method: POST
  title: Creates a FormBlock resource.
  returns: FormBlock
supported operation: Retrieves the collection of FormBlock resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of FormBlock resources.
  returns: Collection

The collection of SubjectRelationship resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: SubjectRelationship
supported operation: Retrieves the collection of SubjectRelationship resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of SubjectRelationship resources.
  returns: Collection

The collection of InformedConsentForm resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: InformedConsentForm
supported operation: Creates a InformedConsentForm resource.
  type: Operation
  type: CreateAction
  expects: InformedConsentForm
  method: POST
  title: Creates a InformedConsentForm resource.
  returns: InformedConsentForm
supported operation: Retrieves the collection of InformedConsentForm resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of InformedConsentForm resources.
  returns: Collection
supported operation: Creates a InformedConsentForm resource.
  type: Operation
  type: CreateAction
  expects: InformedConsentForm
  method: POST
  title: Creates a InformedConsentForm resource.
  returns: InformedConsentForm
supported operation: Creates a InformedConsentForm resource.
  type: Operation
  type: CreateAction
  expects: InformedConsentForm
  method: POST
  title: Creates a InformedConsentForm resource.
  returns: InformedConsentForm

The collection of InformedConsentFormPdf resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: InformedConsentFormPdf
supported operation: Retrieves the collection of InformedConsentFormPdf resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of InformedConsentFormPdf resources.
  returns: Collection

The collection of Language resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Language
supported operation: Retrieves the collection of Language resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Language resources.
  returns: Collection

The collection of Locale resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Locale
supported operation: Retrieves the collection of Locale resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Locale resources.
  returns: Collection

The collection of Organization resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Organization
supported operation: Retrieves the collection of Organization resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Organization resources.
  returns: Collection
supported operation: Creates a Organization resource.
  type: Operation
  type: CreateAction
  expects: Organization
  method: POST
  title: Creates a Organization resource.
  returns: Organization

The collection of Report resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Report
supported operation: Retrieves the collection of Report resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Report resources.
  returns: Collection
supported operation: Creates a Report resource.
  type: Operation
  type: CreateAction
  expects: Report
  method: POST
  title: Creates a Report resource.
  returns: Report

The collection of Site resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Site
supported operation: Retrieves the collection of Site resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Site resources.
  returns: Collection

The collection of StudySite resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: StudySite
supported operation: Retrieves the collection of StudySite resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of StudySite resources.
  returns: Collection
supported operation: Creates a StudySite resource.
  type: Operation
  type: CreateAction
  expects: StudySite
  method: POST
  title: Creates a StudySite resource.
  returns: StudySite

The collection of Integration resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Integration
supported operation: Retrieves the collection of Integration resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Integration resources.
  returns: Collection
supported operation: Creates a Integration resource.
  type: Operation
  type: CreateAction
  expects: Integration
  method: POST
  title: Creates a Integration resource.
  returns: Integration

The collection of StudyInvitation resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: StudyInvitation
supported operation: Retrieves the collection of StudyInvitation resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of StudyInvitation resources.
  returns: Collection
supported operation: Creates a StudyInvitation resource.
  type: Operation
  type: CreateAction
  expects: StudyInvitation
  method: POST
  title: Creates a StudyInvitation resource.
  returns: StudyInvitation

The collection of Study resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Study
supported operation: Retrieves the collection of Study resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Study resources.
  returns: Collection
supported operation: Creates a Study resource.
  type: Operation
  type: CreateAction
  expects: Study
  method: POST
  title: Creates a Study resource.
  returns: Study
supported operation: Retrieves the collection of Study resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Study resources.
  returns: Collection
supported operation: Retrieves the collection of Study resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Study resources.
  returns: Collection
supported operation: Creates a Study resource.
  type: Operation
  type: CreateAction
  expects: Study
  method: POST
  title: Creates a Study resource.
  returns: Study
supported operation: Creates a Study resource.
  type: Operation
  type: CreateAction
  expects: Study
  method: POST
  title: Creates a Study resource.
  returns: Study
supported operation: Creates a Study resource.
  type: Operation
  type: CreateAction
  expects: Study
  method: POST
  title: Creates a Study resource.
  returns: Study

The collection of StudyWithdrawalSetting resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: StudyWithdrawalSetting
supported operation: Creates a StudyWithdrawalSetting resource.
  type: Operation
  type: CreateAction
  expects: StudyWithdrawalSetting
  method: POST
  title: Creates a StudyWithdrawalSetting resource.
  returns: StudyWithdrawalSetting

The collection of Subject resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Subject
supported operation: Retrieves the collection of Subject resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Subject resources.
  deprecated: true
  returns: Collection
supported operation: Retrieves the collection of Subject resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Subject resources.
  returns: Collection
supported operation: Creates a Subject resource.
  type: Operation
  type: CreateAction
  expects: Subject
  method: POST
  title: Creates a Subject resource.
  returns: Subject

The collection of SubjectFormBlockAnswer resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: SubjectFormBlockAnswer
supported operation: Retrieves the collection of SubjectFormBlockAnswer resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of SubjectFormBlockAnswer resources.
  returns: Collection

The collection of SubjectInformedConsentForm resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: SubjectInformedConsentForm
supported operation: Creates a SubjectInformedConsentForm resource.
  type: Operation
  type: CreateAction
  expects: SubjectInformedConsentForm
  method: POST
  title: Creates a SubjectInformedConsentForm resource.
  returns: SubjectInformedConsentForm
supported operation: Creates a SubjectInformedConsentForm resource.
  type: Operation
  type: CreateAction
  expects: SubjectInformedConsentForm
  method: POST
  title: Creates a SubjectInformedConsentForm resource.
  returns: SubjectInformedConsentForm
supported operation: Retrieves the collection of SubjectInformedConsentForm resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of SubjectInformedConsentForm resources.
  returns: Collection
supported operation: Creates a SubjectInformedConsentForm resource.
  type: Operation
  type: CreateAction
  expects: SubjectInformedConsentForm
  method: POST
  title: Creates a SubjectInformedConsentForm resource.
  returns: SubjectInformedConsentForm
supported operation: Retrieves the collection of SubjectInformedConsentForm resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of SubjectInformedConsentForm resources.
  returns: Collection

The collection of SubjectInformedConsentFormPdf resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: InformedConsentFormPdf
supported operation: Retrieves the collection of SubjectInformedConsentFormPdf resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of SubjectInformedConsentFormPdf resources.
  returns: Collection

The collection of InPersonSigningLock resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: InPersonSigningLock
supported operation: Retrieves the collection of InPersonSigningLock resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of InPersonSigningLock resources.
  returns: Collection
supported operation: Creates a InPersonSigningLock resource.
  type: Operation
  type: CreateAction
  expects: InPersonSigningLock
  method: POST
  title: Creates a InPersonSigningLock resource.
  returns: InPersonSigningLock

The collection of Signer resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Signer
supported operation: Retrieves the collection of Signer resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Signer resources.
  returns: Collection
supported operation: Retrieves the collection of Signer resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Signer resources.
  returns: Collection

The collection of SubjectVideoCall resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: SubjectVideoCall
supported operation: Retrieves the collection of SubjectVideoCall resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of SubjectVideoCall resources.
  returns: Collection

The collection of User resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: User
supported operation: Retrieves the collection of User resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of User resources.
  returns: Collection
supported operation: Retrieves the collection of User resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of User resources.
  returns: Collection
supported operation: Retrieves the collection of User resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of User resources.
  returns: Collection

The collection of VideoCallToken resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: VideoCallToken
supported operation: Creates a VideoCallToken resource.
  type: Operation
  type: CreateAction
  expects: VideoCallToken
  method: POST
  title: Creates a VideoCallToken resource.
  returns: VideoCallToken
supported operation: Retrieves the collection of VideoCallToken resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of VideoCallToken resources.
  returns: Collection

The collection of Webhook resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Webhook
supported operation: Retrieves the collection of Webhook resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Webhook resources.
  returns: Collection
supported operation: Creates a Webhook resource.
  type: Operation
  type: CreateAction
  expects: Webhook
  method: POST
  title: Creates a Webhook resource.
  returns: Webhook

ConstraintViolation
type: Class
title: A constraint violation
supported property: SupportedProperty
  property: propertyPath
  title: propertyPath
  description: The property path of the violation
  readable: true
  writeable: false
supported property: SupportedProperty
  property: message
  title: message
  description: The message associated with the violation
  readable: true
  writeable: false

propertyPath
type: Property
domain: ConstraintViolation
range: string

message
type: Property
domain: ConstraintViolation
range: string

Replaces the Subject resource.
type: Operation
type: ReplaceAction
expects: Subject
method: PUT
title: Replaces the Subject resource.
returns: Subject

Replaces the Subject resource.
type: Operation
type: ReplaceAction
expects: Subject
method: PUT
title: Replaces the Subject resource.
returns: Subject

Replaces the Subject resource.
type: Operation
type: ReplaceAction
expects: Subject
method: PUT
title: Replaces the Subject resource.
returns: Subject

Replaces the Subject resource.
type: Operation
type: ReplaceAction
expects: Subject
method: PUT
title: Replaces the Subject resource.
returns: Subject

Retrieves a Subject resource.
type: Operation
type: FindAction
method: GET
title: Retrieves a Subject resource.
returns: Subject

Updates the Subject resource.
type: Operation
expects: Subject
method: PATCH
title: Updates the Subject resource.
returns: Subject