AMODIT API

Class Documentation

AMODWebApp.webservice.AMODWebAPI Class Reference

Public Member Functions

  • string AuthenticateUser ()

This method is used for authentication in system.

  • bool SetCaseAsExported (int caseID)

It’s marks object as exported to QNT.

  • void SetProcedureType (int prcId, int prcTypeId)

Sets type of specified AMODprocedure

  • void UpdateCaseField (int caseId, string FieldName, string fieldValue)

Updates specified case single field value

  • void UpdateCaseFields (int caseId, string[] fieldNames, string[] fieldsValues)

Updates specified case multiple fields values

  • void AddTableFieldToCase (int caseId, int formProcedureId, string tableStructureXml, string tableFieldName)

Adds table to case

  • void DeleteAllTableFieldRecords (int procedureWithTableFieldId, string tableFieldName)

Removes all rows from table placed in field with specified name in specified procedure (for every case)

  • void DeleteTableFieldRecordsConnectedToCase (int procedureWithTableFieldId, string tableFieldName, int caseId)

Removes all rows from table placed in field with specified name in specified procedure (for specified case)

  • DataTable GetProcedureForms (int prcId)

Gets all procedures connected to specified one, defined as a form

  • DataTable GetProcedureTableProcedures (int prcId)

Collects all procedures of specified procedure used to store table fields

  • string GetFormByFieldProcedureType (int caseId, int typeId)

Gets ID of form containing table with specified procedure type id on specified case form

  • DataTable GetProceduresByType (int typeId)

Used by QNT app in configuration options

  • DataSet GetCasesByTypeId (int typeId, int scheduleTypeId, string caseStatus, StringCollection fieldMapping, StringCollection fieldsToInclude)

This function is used by QNT for export application.

  • string GetCase (int caseId)

This method allow to access to single case by Id.

  • string GetCasesByFieldValue (string fieldName, string fieldValue)

Get case by value in specified field

  • string GetCaseIdByFieldValue (string fieldName, string fieldValue)

Gets id of the case by the value of specified field

  • string CloseCase (int caseId, string dateOfModification)

Closes specified case

  • string UpdateCase (int caseId, string dateOfModification, int paramId, String value)

Updates parameter with paramId with value in case with caseId

  • string SendCase (int caseId, int stageId, string dateOfModification, string userDescription, string comment)

Transfers (forwards) case to another user, possibly changing its state and adding a comment

  • string GetUserCases ()

This method gets all cases which are assigned to user.

  • string GetAMODEmail ()

This method gets AMODIT email address.

  • string UserEmailExists (string email)

Check if user with given e-mail address exists.

  • string GetCurrentUserEmails ()

Get all (possibly 4) e-mail addresses for the currently authenticated user.

  • string CaseForward (int caseId, string email, string comment)

Adds user specified by email adress to specified case as CC.

  • string CaseAddAttachment (int caseId, string name, byte[] value)

Adds attachment to specified case.

  • string CaseAddComment (int caseId, string comText)

This method adds comment to specified case.

  • string CaseAddUser (int caseId, string ccEmail, bool addCCnotContrib, string comment)

Adds specified users as CC or Contribuitors. If needed, creates new user account and sends invite email.

  • string CreateCase (string procedureTitle, string startingStateTitle, string caseTitle)

This method creates a new case.

  • byte[] FindCase (int caseId, string caseTitle, string procedureTitle, int limit)

This method gets a list of cases matching given filter.

  • string GetMostUsedProceduresForCurrentUser (int rowLimit)

This method gets a list of the most used procedures for currently authenticated user.

  • string GetMostUsedProcedures (int userId, int rowLimit)

This method gets a list of the most used procedure for specified user.

  • string GetProcedure (string title)

This method gets a procedure which name matches specified string.

  • string GetProcedureSchemaByTitle (string procedureTitle)

Gets procedure schema for procedure that name matches specified string

  • string GetProcedureSchema (int procedureId)

Gets procedure schema by procedure id

  • string GetProcedures (string prefixText, int maxProcedures)

This method gets a list of procedure names matching specified string.

  • string GenerateDefaultTitle (string prcTitle)

This method returns default case title for given procedure name.

  • string GetUser (int userId)

Gets user info

  • string ForwardCase (int caseId, string stage, string user, bool ignoreRestrictions, bool sendEmail)

Forwards case to specified user.

  • void LogToAMODLog (string message, string callStack)

Logs specified message and callstack to AMOD Logs

 

 

Member Function Documentation

void AMODWebApp.webservice.AMODWebAPI.AddTableFieldToCase (int  caseId, int  formProcedureId, string  tableStructureXml, string  tableFieldName)

 

Adds table to case

 

Parameters:
caseId Id of the case
formProcedureId Form procedure id
tableStructureXml New table’s structure in XML format
tableFieldName New field’s name

string AMODWebApp.webservice.AMODWebAPI.AuthenticateUser ()

 

This method is used for authentication in system.

 

Returns:

If authentication is successfully, method returns GUID. If authentication is failure method returns description of error.

string AMODWebApp.webservice.AMODWebAPI.CaseAddAttachment (int  caseId, string  name, byte[]  value)

 

Adds attachment to specified case.

 

Parameters:
caseId Id of the case
name Name of the attachment
value Attachment content
Returns:

Empty string if success, otherwise appropriate messsage

string AMODWebApp.webservice.AMODWebAPI.CaseAddComment (int  caseId, string  comText)

 

This method adds comment to specified case.

 

Parameters:
caseId Id of the case
comText Comment content
Returns:

Empty string if success, otherwise appropriate messsage

string AMODWebApp.webservice.AMODWebAPI.CaseAddUser (int  caseId, string  ccEmail, bool  addCCnotContrib, string  comment)

 

Adds specified users as CC or Contribuitors. If needed, creates new user account and sends invite email.

 

Parameters:
caseId The id of the case
ccEmail Email list, separated by ’;’
addCCnotContrib True if users are to be added as CC, false if as CON
comment Additional comment
Returns:

Empty string if successful, appropriate message otherwise

string AMODWebApp.webservice.AMODWebAPI.CaseForward (int  caseId, string  email, string  comment)

 

Adds user specified by email adress to specified case as CC.

 

Parameters:
caseId Id of the case
email Email of user to be added as CC.
comment Additional comment to be added to the case.
Returns:

Empty string if successful, appropriate message otherwise

string AMODWebApp.webservice.AMODWebAPI.CloseCase (int  caseId, string  dateOfModification)

 

Closes specified case

 

Parameters:
caseId Id of the case
dateOfModification Last date of case modification
Returns:

XML formatted response, indicating wheter operation was successful or not

string AMODWebApp.webservice.AMODWebAPI.CreateCase (string  procedureTitle, string  startingStateTitle, string  caseTitle)

 

This method creates a new case.

 

Parameters:
procedureTitle Name of existing or to be created procedure
startingStateTitle Name of starting stage
caseTitle Name of created case
Returns:

XML file with case Id, otherwise appropriate message

void AMODWebApp.webservice.AMODWebAPI.DeleteAllTableFieldRecords (int  procedureWithTableFieldId, string  tableFieldName)

 

Removes all rows from table placed in field with specified name in specified procedure (for every case)

 

Parameters:
procedureWithTableFieldId Id of the procedure containing table field
tableFieldName Name of the field containing table

void AMODWebApp.webservice.AMODWebAPI.DeleteTableFieldRecordsConnectedToCase (int  procedureWithTableFieldId, string  tableFieldName, int  caseId)

 

Removes all rows from table placed in field with specified name in specified procedure (for specified case)

 

Parameters:
procedureWithTableFieldId Id of the procedure containing table field
tableFieldName Name of the field containing table
caseId Id of the case containing table

byte [] AMODWebApp.webservice.AMODWebAPI.FindCase (int  caseId, string  caseTitle, string  procedureTitle, int  limit)

 

This method gets a list of cases matching given filter.

 

Parameters:
caseId case identifier
caseTitle case title filter
procedureTitle procedure title filter
limit maximum number of cases returned
Returns:

Compressed XML file with list of cases.

string AMODWebApp.webservice.AMODWebAPI.ForwardCase (int  caseId, string  stage, string  user, bool  ignoreRestrictions, bool  sendEmail)

 

Forwards case to specified user.

 

Parameters:
caseId Id of the case to be forwarded
stage Stage to be changed to
user User login to whom the case is to be forwarded to
ignoreRestrictions True if case should be forwarded despite restrictions, false otherwise
sendEmail True if notification email should be sent, false otherwise
Returns:

Empty string on success, otherwise an appropriate message

string AMODWebApp.webservice.AMODWebAPI.GenerateDefaultTitle (string  prcTitle)

 

This method returns default case title for given procedure name.

 

Parameters:
prcTitle procedure title
Returns:

XML file with default case title.

string AMODWebApp.webservice.AMODWebAPI.GetAMODEmail ()

 

This method gets AMODIT email address.

 

Returns:

XML file with an email address.

string AMODWebApp.webservice.AMODWebAPI.GetCase (int  caseId)

 

This method allow to access to single case by Id.

 

Parameters:
caseId
Returns:

XML file with description of parameters from AMODCase

string AMODWebApp.webservice.AMODWebAPI.GetCaseIdByFieldValue (string  fieldName, string  fieldValue)

 

Gets id of the case by the value of specified field

 

Parameters:
fieldName specified field name
fieldValue specified field value
Returns:

id of first case with the value in the field, when no cases found returns -1

string AMODWebApp.webservice.AMODWebAPI.GetCasesByFieldValue (string  fieldName, string  fieldValue)

 

Get case by value in specified field

 

Parameters:
fieldName Specified field name
fieldValue value in field
Returns:

string containing xml representation of AMODCase object

DataSet AMODWebApp.webservice.AMODWebAPI.GetCasesByTypeId (int  typeId, int  scheduleTypeId, string  caseStatus, StringCollection  fieldMapping, StringCollection  fieldsToInclude)

 

This function is used by QNT for export application.

 

Parameters:
typeId
scheduleTypeId
caseStatus
fieldMapping
fieldsToInclude
Returns:

Dataset object

string AMODWebApp.webservice.AMODWebAPI.GetCurrentUserEmails ()

 

Get all (possibly 4) e-mail addresses for the currently authenticated user.

 

Returns:

Xml file with list of e-mail addresses.

string AMODWebApp.webservice.AMODWebAPI.GetFormByFieldProcedureType (int  caseId, int  typeId)

 

Gets ID of form containing table with specified procedure type id on specified case form

 

Parameters:
caseId Id of the case to search on
typeId Id of table form procedure
Returns:

Id of table form procedure, or -1 when not found

string AMODWebApp.webservice.AMODWebAPI.GetMostUsedProcedures (int  userId, int  rowLimit)

 

This method gets a list of the most used procedure for specified user.

 

Parameters:
userId The id of the user
rowLimit Maximum number of returned procedures
Returns:

XML file with list of the most used procedure names, ids and information if user can add new stages.

string AMODWebApp.webservice.AMODWebAPI.GetMostUsedProceduresForCurrentUser (int  rowLimit)

 

This method gets a list of the most used procedures for currently authenticated user.

 

Parameters:
rowLimit
Returns:

XML file with list of the most used procedure names, ids and information if user can add new stages.

string AMODWebApp.webservice.AMODWebAPI.GetProcedure (string  title)

 

This method gets a procedure which name matches specified string.

 

Parameters:
title The title to be matched
Returns:

XML file with basic procedure parameters.

DataTable AMODWebApp.webservice.AMODWebAPI.GetProcedureForms (int  prcId)

 

Gets all procedures connected to specified one, defined as a form

 

Parameters:
prcId id of specified procedure
Returns:

DataTable obiect containing all form procedures

string AMODWebApp.webservice.AMODWebAPI.GetProcedures (string  prefixText, int  maxProcedures)

 

This method gets a list of procedure names matching specified string.

 

Parameters:
prefixText
maxProcedures Maxiumum number of returned procedures
Returns:

XML file with list of procedure names and ids.

DataTable AMODWebApp.webservice.AMODWebAPI.GetProceduresByType (int  typeId)

 

Used by QNT app in configuration options

 

Parameters:
typeId Id of type
Returns:

DataTable with all active procedures of specified type

string AMODWebApp.webservice.AMODWebAPI.GetProcedureSchema (int  procedureId)

 

Gets procedure schema by procedure id

 

Parameters:
procedureId The id of the procedure
Returns:

XML formatted list of procedure parameters

string AMODWebApp.webservice.AMODWebAPI.GetProcedureSchemaByTitle (string  procedureTitle)

 

Gets procedure schema for procedure that name matches specified string

 

Parameters:
procedureTitle The name to match
Returns:

XML formatted list of procedure parameters

DataTable AMODWebApp.webservice.AMODWebAPI.GetProcedureTableProcedures (int  prcId)

 

Collects all procedures of specified procedure used to store table fields

 

Parameters:
prcId specified procedure id
Returns:

DataTable with table procedures

string AMODWebApp.webservice.AMODWebAPI.GetUser (int  userId)

 

Gets user info

 

Parameters:
userId Id of the user
Returns:

XML formatted user property list

string AMODWebApp.webservice.AMODWebAPI.GetUserCases ()

 

This method gets all cases which are assigned to user.

 

Returns:

XML file with ful description of Cases which are assigned to user. List of all cases with list of comments and descriptions of main form.

void AMODWebApp.webservice.AMODWebAPI.LogToAMODLog (string  message, string  callStack)

 

Logs specified message and callstack to AMOD Logs

 

Parameters:
message The message to be logged
callStack The call stack to be logged

string AMODWebApp.webservice.AMODWebAPI.SendCase (int  caseId, int  stageId, string  dateOfModification, string  userDescription, string  comment)

 

Transfers (forwards) case to another user, possibly changing its state and adding a comment

 

Parameters:
caseId Id of the case to be forwarded
stageId Id of the stage to be changed to
dateOfModification Last date of modification in „yyyy-MM-dd HH:mm:ss” format
userDescription Login of the user to whom the case is to be forwarded
comment Value of the comment to be added
Returns:

Operation summary in xml form

bool AMODWebApp.webservice.AMODWebAPI.SetCaseAsExported (int  caseID)

 

It’s marks object as exported to QNT.

 

Parameters:
caseID Id number of case
Returns:

True if case was set, false otherwise.

void AMODWebApp.webservice.AMODWebAPI.SetProcedureType (int  prcId, int  prcTypeId)

 

Sets type of specified AMODprocedure

 

Parameters:
prcId specified procedure id
prcTypeId specified type id

string AMODWebApp.webservice.AMODWebAPI.UpdateCase (int  caseId, string  dateOfModification, int  paramId, String  value)

 

Updates parameter with paramId with value in case with caseId

 

Parameters:
caseId Id of the case where the field is to be updated
dateOfModification Last date of modification in „yyyy-MM-dd HH:mm:ss” format
paramId Id of parameter to be updated
value New value to be set
Returns:

Update summary in xml form

void AMODWebApp.webservice.AMODWebAPI.UpdateCaseField (int  caseId, string  FieldName, string  fieldValue)

 

Updates specified case single field value

 

Parameters:
caseId Id of AMOD Case containing field to be updated
FieldName Name of the field to be updated
fieldValue New field value

void AMODWebApp.webservice.AMODWebAPI.UpdateCaseFields (int  caseId, string[]  fieldNames, string[]  fieldsValues)

 

Updates specified case multiple fields values

 

Parameters:
caseId Id of AMOD Case containing field to be updated
fieldNames Names of the fields to be updated
fieldsValues New fields values

string AMODWebApp.webservice.AMODWebAPI.UserEmailExists (string  email)

 

Check if user with given e-mail address exists.

 

Parameters:
email E-mail address to be searched for
Returns:

„true” if user exists or „false” otherwise

Was this article helpful?
0 out Of 5 Stars
5 Stars 0%
4 Stars 0%
3 Stars 0%
2 Stars 0%
1 Stars 0%
How can we improve this article?
Please submit the reason for your vote so that we can improve the article.