Phoenix DataCapture

Flexible backend data store

DeleteResponse

Properties

Name Type Description

Operations

DeactivateModule
Sets the Project record to inactiveSoapRestC#
DeleteEntry
Deletes a Entry by its IdSoapRestC#
DeleteEntryFile
Deletes a EntryFile by its IdSoapRestC#
DeleteEntrySet
Deletes a EntrySet by its IdSoapRestC#
DeleteParam
Deletes a Param by its IdSoapRestC#
DeleteReport
Deletes a Report by its IdSoapRestC#

Entry

An Entry is a list of key value pairs that conform to the Params that the EntrySet defines.

Properties

Name Type Description
IdSystem.Int32 the primary Identifier for the Entry[queryable][sortable]
ParametersList<KeyValuePair<string, string>> The XML structure representing the data (In the specific structure)[required]
ReferenceSystem.StringAn external reference[required]
CreateDateSystem.DateTime UTC date of when this Object was created[queryable][readonly][sortable]
ModifyDateSystem.DateTime UTC date of when this Object last modified[queryable][sortable]

Operations

CreateEntry
Creates a new Entry object required to authenticate end usersSoapRestC#
GetEntry
Gets a single Entry entity by its IdSoapRestC#
ListEntry
Returns a paged list of Entry optionally filtered and sortedSoapRestC#
UpdateEntry
Updates a Entry entitySoapRestC#

EntryFile

An Entry may contain a binary file.

Properties

Name Type Description
IdSystem.Int32 the primary identifier of the EntryFile[queryable][sortable]
ParamIdSystem.Int32The Param that entryfile belongs to[required]
FileNameSystem.StringThe human readable name given to this EntryFile[required]
MimeTypeSystem.StringThe mime type of the file. e.g image/jpeg[required]
UrlSystem.StringThe Url of the file acessible over http[required]
CreateDateSystem.DateTime UTC date of when this Object was created[readonly]
ModifyDateSystem.DateTimeUTC date of when this Object last modified
ParamParamNavigation property to Param [expandable]

Operations

GetEntryFile
Gets a single EntryFile entity by its IdSoapRestC#
ListEntryFile
Returns a paged list of EntryFile optionally filtered and sortedSoapRestC#

EntrySet

EntrySets are collections of Entries and provide data structure definition of those Entries.

Properties

Name Type Description
IdSystem.Int32 the primary identifier of the EntrySet[queryable][sortable]
ProjectIdSystem.Int32the Project that this EntrySet belongs to[required]
NameSystem.StringThe human readable name given to this EntrySet[required]
DescriptionSystem.StringA longer description about this EntrySet
IsActiveSystem.BooleanWhether this EntrySet should be publicly visible or not [queryable][sortable][required]
IsEntryDeletableSystem.BooleanWhether this Article should be publicly visible or not [queryable][sortable][required]
HasReferenceSystem.BooleanWhether this EntrySet should be removable or not [queryable][sortable][required]
CustomEditControlSystem.StringCustomizable edit control, defined by the type for this entryset
CreateDateSystem.DateTime UTC date of when this Object was created[readonly]
ModifyDateSystem.DateTimeUTC date of when this Object last modified
EntriesICollection[]Navigation property to Entry [expandable]
ProjectProjectNavigation property to Project [expandable]

Operations

CreateEntrySet
Creates a new EntrySet object required to authenticate end usersSoapRestC#
GetEntrySet
Gets a single EntrySet entity by its IdSoapRestC#
ListEntrySet
Returns a paged list of EntrySet optionally filtered and sortedSoapRestC#
UpdateEntrySet
Updates a EntrySet entitySoapRestC#

Param

Params define the type of data that is stored within an Entry.

Properties

Name Type Description
IdSystem.Int32 the primary identifier of the Param[queryable][sortable]
EntrySetIdSystem.Int32 the EntrySet that this Param belongs to[queryable][required]
ParamTypeIdParamTypeEnumthe param type from the ParamType lookup table
NameSystem.StringThe human readable name given to this Param[required]
ReportDisplayRankSystem.Int32The order number of the param in the report[required]
IsMandatorySystem.BooleanWhether this Parameter is required when adding an Entry [queryable][sortable][required]
IsReportedSystem.BooleanWhether this Parameter is reportable when adding an Entry [queryable][sortable][required]
ValidationParamSystem.StringValidation text based on paramtype
DisplayParamSystem.StringDisplay format based on paramtype
DescriptionSystem.StringA longer description about this Param
ValidationErrorSystem.StringThe error message when validation fails
IsSummarySystem.BooleanWhether this Parameter is used when rolling up the summary [queryable][sortable][required]
CreateDateSystem.DateTime UTC date of when this Object was created[readonly]
ModifyDateSystem.DateTimeUTC date of when this Object last modified
EntrySetEntrySetNavigation property to EntrySet [expandable]

Operations

CreateParam
Creates a new Param object required to authenticate end usersSoapRestC#
GetParam
Gets a single Param entity by its IdSoapRestC#
ListParam
Returns a paged list of Param optionally filtered and sortedSoapRestC#
UpdateParam
Updates a Param entitySoapRestC#

Project

Projects provide the isolation of data from each other.

Properties

Name Type Description
PhoenixIdentity_ProjectIdSystem.Int32 References PhoenixSecurity.Project.Id[queryable][sortable][required]
DeliveryUrlSystem.StringThe delivery URL for the Project[required]
CreateDateSystem.DateTime UTC date of when this Object was created[readonly]
ModifyDateSystem.DateTimeUTC date of when this Object last modified

Operations

ActivateModule
Activates the module for a particular project by creating a new Project recordSoapRestC#
GetModuleSettings
Gets the DataCapture.Project recordSoapRestC#
UpdateModuleSettings
Updates the settings for this Project recordSoapRestC#

Report

Properties

Name Type Description
IdSystem.Int32 the primary identifier of the Report[queryable][sortable]
ReportTypeIdSystem.ByteThe Type of Report this is[required]
EntrySetIdSystem.Int32the EntrySet that this Report belongs to[required]
ReportNameSystem.StringThe human readable name given to this Report[required]
ReportPathSystem.StringPhysical path of the report file[required]
CreateDateSystem.DateTime UTC date of when this Object was created[readonly]
ModifyDateSystem.DateTimeUTC date of when this Object last modified
EntrySetEntrySetNavigation property to EntrySet [expandable]

Operations

CreateReport
Creates a new Report object required to authenticate end usersSoapRestC#
GetReport
Gets a single Report entity by its IdSoapRestC#
ListReport
Returns a paged list of Report optionally filtered and sortedSoapRestC#
UpdateReport
Updates a Report entitySoapRestC#

UploadEntryFileResponse

Properties

Name Type Description

Operations

UploadEntryFile
Upload a EntryFileSoapRestC#