| Service | Version | API | hits | /min | Sucess | Seconds | Description |
|---|---|---|---|---|---|---|---|
| absence/getForPerson | 1.0 | JS|Q|∠ | Get Official Absence details for any person. May return null - not present. | ||||
| absence/getMine | 1.0 | JS|Q|∠ | Get absence details for editing. | ||||
| absence/set | 1.0 | JS|Q|∠ | Set absence details for editing, returns updated instance. | ||||
| audit/entriesSince | 1.0 | JS|Q|∠ | Get audit entries since a specific date. | ||||
| billing/createBillingInfo | 1.0 | JS|Q|∠ | Create Billing Information. | ||||
| billing/getBillingInfo | 1.0 | JS|Q|∠ | Get Billing Information by ID. | ||||
| billing/removeBillingInfo | 1.0 | JS|Q|∠ | Remove Billing Information by ID. | ||||
| billing/updateBillingInfo | 1.0 | JS|Q|∠ | Update Billing Information. | ||||
| cases/ValidateCaseContent | 1.0 | JS|Q|∠ | Validate case contents and return whether the case information is complete. | ||||
| cases/acceptSuggestedSettlement | 1.0 | JS|Q|∠ | When a suggested settlement is made, the plaintiff may accept the suggested settlement. | ||||
| cases/addCaseDialogEntry | 1.0 | JS|Q|∠ | Adding message to a case dialog, receive the dialog entry's id. | ||||
| cases/addCaseReviewer | 1.0 | JS|Q|∠ | Add a person to the Case Reviewers list for a case. | ||||
| cases/addTimelineEntry | 1.0 | JS|Q|∠ | Adding message to timeline | ||||
| cases/appendToMyEvaluationDraft | 1.0 | JS|Q|∠ | Append your evaluation draft for a case. | ||||
| cases/assignCaseWorker | 1.0 | JS|Q|∠ | Assign case to a case worker from the handling organisation. | ||||
| cases/assignDefendantsCaseWorker | 1.0 | JS|Q|∠ | Assign case to a case worker from the handling organisation. | ||||
| cases/attachmentGroups | 1.0 | JS|Q|∠ | Get all attachment groups for a case type. | ||||
| cases/attachments | 1.0 | JS|Q|∠ | Get attached file extending the path by /[case_id]/[access_group]/[filename.ext]. | ||||
| cases/bulkEmail | 1.0 | JS|Q|∠ | Send bulk emails to a number of persons or defendants. Both HTML and TEXT email is possible. The execution is asynchronous. | ||||
| cases/canSetCaseStatus | 1.0 | JS|Q|∠ | Check if you can set a status on a case. Either returns or throws an exception. | ||||
| cases/caseAttachments | 1.0 | JS|Q|∠ | Get information on last version of all attachments for a case. | ||||
| cases/caseEnums | 1.0 | JS|Q|∠ | Get the options for a named Case Enum that are valid right now | ||||
| cases/caseLogSearch | 1.0 | JS|Q|∠ | Search for entries in the case log and return suitable number of hits. | ||||
| cases/caseSummaryIsReady | 1.0 | JS|Q|∠ | Update the case summary, some actions may not be allowed. | ||||
| cases/caseTypeOfPerson | 1.0 | JS|Q|∠ | Get FIRST CaseType that person is associated with. First find is returned. | ||||
| cases/changeAttachmentDocumentType | 1.0 | JS|Q|∠ | Change an attachments document type. | ||||
| cases/clearBillingData | 1.0 | JS|Q|∠ | Clear billing data for case. | ||||
| cases/closeCase | 1.0 | JS|Q|∠ | Close a case before reaching the resolution stage. | ||||
| cases/copyCase | 1.0 | JS|Q|∠ | Copy a case | ||||
| cases/copyCaseDialogEntry | 1.0 | JS|Q|∠ | Adding an existing message to a case dialog, by copying it. | ||||
| cases/createCase | 1.0 | JS|Q|∠ | Create a new case and return case ID. Status will be 'Registration'. Returns UUID. | ||||
| cases/createInvoice | 1.0 | JS|Q|∠ | Create a new invoice and return it. | ||||
| cases/createLegalFormulation | 1.0 | JS|Q|∠ | Case Legal Evaluation Method. | ||||
| cases/createLegalQuestion | 1.0 | JS|Q|∠ | Case Legal Evaluation Method. | ||||
| cases/createLegalReason | 1.0 | JS|Q|∠ | Case Legal Evaluation Method. | ||||
| cases/createLegalRequirement | 1.0 | JS|Q|∠ | Case Legal Evaluation Method. | ||||
| cases/defendantPersons | 1.0 | JS|Q|∠ | Get a list of all defendant persons. | ||||
| cases/defendantSuggestedSettlement | 1.0 | JS|Q|∠ | The defendant may suggest a settlement. Sends email to all parties to notify them that the defendant has made a suggested settlement | ||||
| cases/deleteAttachment | 1.0 | JS|Q|∠ | Delete an uploaded case attachment. | ||||
| cases/deleteInvoice | 1.0 | JS|Q|∠ | Remove an invoice. | ||||
| cases/deleteLegalFormulation | 1.0 | JS|Q|∠ | Case Legal Evaluation Method. | ||||
| cases/deleteLegalQuestion | 1.0 | JS|Q|∠ | Case Legal Evaluation Method. | ||||
| cases/deleteLegalReason | 1.0 | JS|Q|∠ | Case Legal Evaluation Method. | ||||
| cases/deleteLegalRequirement | 1.0 | JS|Q|∠ | Case Legal Evaluation Method. | ||||
| cases/deleteTimelineEntry | 1.0 | JS|Q|∠ | Delete a timeline entry. | ||||
| cases/discussionAdd | 1.0 | JS|Q|∠ | Adding message to internal case workers dialog | ||||
| cases/discussionList | 1.0 | JS|Q|∠ | Get dialog entries from discussion area of organisation. | ||||
| cases/exportPersonalInformationAsZIP | 1.0 | JS|Q|∠ | Download a ZIP structure of case information and attachments for plaintiff. | ||||
| cases/exportPersonalInformationCaseOnly | 1.0 | JS|Q|∠ | Download a JSON structure of case information for plaintiff. | ||||
| cases/forgotPassword | 1.0 | JS|Q|∠ | Call this to initiate a password reset for the given user - together with a case ID. | ||||
| cases/getAnonymizedText | 1.0 | JS|Q|∠ | Get ingress and text that represent the anonymized case. | ||||
| cases/getAttachmentInternalNotes | 1.0 | JS|Q|∠ | Get attachments internal notes for a case. | ||||
| cases/getAvailableReports | 1.0 | JS|Q|∠ | Return available reports. | ||||
| cases/getBillingInfo | 1.0 | JS|Q|∠ | Get specific billing information for this case. | ||||
| cases/getBoardMeetingDate | 1.0 | JS|Q|∠ | Get the board meeting date for a given case, may return null if not set. | ||||
| cases/getCase | 1.0 | JS|Q|∠ | Get generic case information for a case. When a case is claimed, the person must be authenticated. | ||||
| cases/getCaseFieldsForID | 1.0 | JS|Q|∠ | Get field definitions for Case Information for a specific case type by case type ID. | ||||
| cases/getCaseFieldsForName | 1.0 | JS|Q|∠ | Get field definitions for Case Information for a specific case type by name. | ||||
| cases/getCaseInformation | 1.0 | JS|Q|∠ | Get all case information for this case. Using a map of field_id,value. | ||||
| cases/getCasePlaintiffContact | 1.0 | JS|Q|∠ | Get Contact information for plaintiff or representatives, if present. | ||||
| cases/getCaseResolution | 1.0 | JS|Q|∠ | Get the details of the Case Resolution. | ||||
| cases/getCaseResolutionTypes | 1.0 | JS|Q|∠ | Get a list of the Case Resolution Types for a Case Type. | ||||
| cases/getCaseReviewers | 1.0 | JS|Q|∠ | Get the list of required case reviewers for a given case. | ||||
| cases/getCaseStatus | 1.0 | JS|Q|∠ | Get case status | ||||
| cases/getCaseStatuses | 1.0 | JS|Q|∠ | Get all case statuses in the database, returns null if there are none. | ||||
| cases/getCaseSummary | 1.0 | JS|Q|∠ | Get the case summary for a given case, may return null if the summary is not yet available to work with. | ||||
| cases/getCaseSummaryTexts | 1.0 | JS|Q|∠ | Get the case summary texts. This is only available to the plaintiff and defendant after the case is closed. | ||||
| cases/getCaseTypeById | 1.0 | JS|Q|∠ | Return case type by id. | ||||
| cases/getCaseTypeByName | 1.0 | JS|Q|∠ | Return case type by name. | ||||
| cases/getCaseTypeConfigurationsByName | 1.0 | JS|Q|∠ | Get configurations Map<name,validator> for case type, by the case type name. | ||||
| cases/getCaseTypeExpense | 1.0 | JS|Q|∠ | Get Expense configuration for a named case Type. | ||||
| cases/getCaseTypes | 1.0 | JS|Q|∠ | Return list of existing case types. | ||||
| cases/getCasesFor | 1.0 | JS|Q|∠ | Get generic case information for all cases registered by a person. | ||||
| cases/getDates | 1.0 | JS|Q|∠ | Get case dates. | ||||
| cases/getDefaultSettlementText | 1.0 | JS|Q|∠ | Returns the standard suggested settlement text for this case. | ||||
| cases/getDefendant | 1.0 | JS|Q|∠ | Get full defendant information, restricted to administrator and case workers. | ||||
| cases/getDefendantByOrganisation | 1.0 | JS|Q|∠ | Get full defendant information by organisation, only for ADMINISTRATOR or CASE_ADMINISTRATOR. | ||||
| cases/getDefendantExpense | 1.0 | JS|Q|∠ | Get defendant expense configuration for a given defendant. | ||||
| cases/getDefendantNames | 1.0 | JS|Q|∠ | Get a ordered list of all registered and validated defendants, ID's and names only. | ||||
| cases/getDefendantsCaseData | 1.0 | JS|Q|∠ | Get Defendants Case Data for a given case. | ||||
| cases/getDefendantsForDataTable | 1.0 | JS|Q|∠ | Get a ordered list for DataTables of all registered and validated defendants, including org_id. | ||||
| cases/getDialogEntries | 1.0 | JS|Q|∠ | Retrieving dialog entries of a particular type, associated with a case | ||||
| cases/getLegalEvaluationForCase | 1.0 | JS|Q|∠ | Get structure for legal evaluation of this case. | ||||
| cases/getLegalEvaluationHtmlForCase | 1.0 | JS|Q|∠ | Get evaluation text for selected legal evaluation structure. | ||||
| cases/getLog | 1.0 | JS|Q|∠ | Get all entries in the Case Log for a case. | ||||
| cases/getMail | 1.0 | JS|Q|∠ | Get a specific mail for a given case. | ||||
| cases/getMailLog | 1.0 | JS|Q|∠ | Get all entries in the Case Mail Log for a case. | ||||
| cases/getMyEvaluationDraft | 1.0 | JS|Q|∠ | Get your evaluation draft for a case. | ||||
| cases/getPublicDefendant | 1.0 | JS|Q|∠ | Get Defendant information, for all authenticated users. | ||||
| cases/getPublicDefendants | 1.0 | JS|Q|∠ | Get a ordered list of all registered and validated defendants for a case type. | ||||
| cases/getPublishedCase | 1.0 | JS|Q|∠ | Get published case by internal case id - no permissions required. | ||||
| cases/getPublishedCaseByRefno | 1.0 | JS|Q|∠ | Get published case by case reference number - no permissions required. | ||||
| cases/getPublishedDefendants | 1.0 | JS|Q|∠ | Get a ordered list of all defendants with published cases. | ||||
| cases/getReportGraph | 1.0 | JS|Q|∠ | Get information about a Graph in the report. | ||||
| cases/getReportGraphCSV | 1.0 | JS|Q|∠ | Get CSV extract for a Graph in the report. | ||||
| cases/getReportGraphData | 1.0 | JS|Q|∠ | Get information about a Graph in the report. | ||||
| cases/getReportLayout | 1.0 | JS|Q|∠ | Get layout of a report. | ||||
| cases/getReportTable | 1.0 | JS|Q|∠ | Get information about a Table in the report. | ||||
| cases/getReportTableData | 1.0 | JS|Q|∠ | Get the data of a table in a report. | ||||
| cases/getSingleCaseInformation | 1.0 | JS|Q|∠ | Get a single case information by field_id, throws exception if the field is not accessible. | ||||
| cases/getTimelineEntries | 1.0 | JS|Q|∠ | Retrieving timeline entries of a particular type, associated with a case | ||||
| cases/ignoreMailError | 1.0 | JS|Q|∠ | Ignore a specific Case Mail Error. | ||||
| cases/insertCaseEnum | 1.0 | JS|Q|∠ | Insert a brand new case enum. | ||||
| cases/invoiceLines | 1.0 | JS|Q|∠ | Calculate and return invoice lines between two dates. | ||||
| cases/invoiceList | 1.0 | JS|Q|∠ | Returns list of invoices for this case. | ||||
| cases/isMemberOfHandlingOrganisationForCaseType | 1.0 | JS|Q|∠ | Check if person is member of handling organisation for a given case type. Does NOT check persons roles! | ||||
| cases/listAccessGroups | 1.0 | JS|Q|∠ | Get all available access groups for case attachments. | ||||
| cases/listBoardMeetings | 1.0 | JS|Q|∠ | List all upcoming board meetings and respective cases. | ||||
| cases/listCaseDeadlines | 1.0 | JS|Q|∠ | Get Case Deadlines for a case. | ||||
| cases/listCaseEnum | 1.0 | JS|Q|∠ | Get all options for a named Case Enum | ||||
| cases/listCaseLegalWordpills | 1.0 | JS|Q|∠ | List wordpills that are defined for a given case | ||||
| cases/listCasesWithRemovalRequests | 1.0 | JS|Q|∠ | List cases that are requested to be removed (and not deleted/closed/resolved already). | ||||
| cases/listDefendantCategoryExpenses | 1.0 | JS|Q|∠ | List defendant expenses by case type. Direct defendant expenses are not returned here. | ||||
| cases/listEnums | 1.0 | JS|Q|∠ | Get all enum values | ||||
| cases/listEvents | 1.0 | JS|Q|∠ | List all configured events on the case. | ||||
| cases/listLegalFormulationsForLegalQuestion | 1.0 | JS|Q|∠ | Case Legal Evaluation Method. | ||||
| cases/listLegalQuestionsForLegalReason | 1.0 | JS|Q|∠ | Case Legal Evaluation Method. | ||||
| cases/listLegalReasonsForLegalRequirement | 1.0 | JS|Q|∠ | Case Legal Evaluation Method. | ||||
| cases/listLegalRequirementsForCaseType | 1.0 | JS|Q|∠ | Case Legal Evaluation Method. | ||||
| cases/listLegalWordpillsForCaseType | 1.0 | JS|Q|∠ | List configured legal word pills for a case type. | ||||
| cases/listSimilarlyEvaluatedCases | 1.0 | JS|Q|∠ | List a number (max 10) closed cases that have similar legal evaluation to this case. | ||||
| cases/moveToEvaluation | 1.0 | JS|Q|∠ | Move case to evaluation without any notifications. | ||||
| cases/numberOfMailErrors | 1.0 | JS|Q|∠ | How many unignored mail errors exist for this case. | ||||
| cases/overrideToError | 1.0 | JS|Q|∠ | Override a specific label, setting it to ERROR level if it occurs. | ||||
| cases/overrideToInformation | 1.0 | JS|Q|∠ | Override a specific label, setting it to INFORMATION level if it occurs. | ||||
| cases/overrideToWarning | 1.0 | JS|Q|∠ | Override a specific label, setting it to WARNING level if it occurs. | ||||
| cases/personsOrganisations | 1.0 | JS|Q|∠ | Get all organisations and defendant that a person is connected to and whether or not they have a validated connection. | ||||
| cases/populatePlaintiffsTimeline | 1.0 | JS|Q|∠ | Adding message to timeline | ||||
| cases/publishCase | 1.0 | JS|Q|∠ | Publish an anonymized case. | ||||
| cases/publishedAt | 1.0 | JS|Q|∠ | When a case was published, null if not yet published. | ||||
| cases/quickCreateCase | 1.0 | JS|Q|∠ | <b>Create a case for the plaintiff and defendant as a third party.<b/>
<p/> The case is automatically moved forward to PREPARATION status. The person that created the case become the assigned case worker. | ||||
| cases/quickResolve | 1.0 | JS|Q|∠ | Quickly Resolve a case as the case worker. Return case_id on success. | ||||
| cases/readLegalFormulation | 1.0 | JS|Q|∠ | Case Legal Evaluation Method. | ||||
| cases/readLegalQuestion | 1.0 | JS|Q|∠ | Case Legal Evaluation Method. | ||||
| cases/readLegalReason | 1.0 | JS|Q|∠ | Case Legal Evaluation Method. | ||||
| cases/readLegalRequirement | 1.0 | JS|Q|∠ | Case Legal Evaluation Method. | ||||
| cases/recreateSummary | 1.0 | JS|Q|∠ | Recreate the Case Summary from Case Information if Case is in Evaluating. | ||||
| cases/regenerateAnonymizedCase | 1.0 | JS|Q|∠ | Regenerate anonymized case if state is Ok and anonymized_case is empty. | ||||
| cases/registerDefendant | 1.0 | JS|Q|∠ | Register a new defendant. Any one can create a new defendant. Remember to define case_type_id, defaults to 'brukerklage'. | ||||
| cases/registerDefendantMember | 1.0 | JS|Q|∠ | Add unvalidated member to an unvalidated defendant. | ||||
| cases/rejectSuggestedSettlement | 1.0 | JS|Q|∠ | When a suggested settlement is made, the plaintiff may reject the suggested settlement. | ||||
| cases/removeCase | 1.0 | JS|Q|∠ | Completely remove a case from the system. | ||||
| cases/removeCaseReviewer | 1.0 | JS|Q|∠ | Remove a person from the Case Reviewers list for a case. | ||||
| cases/removeDefendant | 1.0 | JS|Q|∠ | Remove defendant given the defendant ID. Must be CASE Admin. Not yet tested. | ||||
| cases/removePersonalInformationFromCase | 1.0 | JS|Q|∠ |
Remove personal information in a case from the system.Restrictions:
| ||||
| cases/requestRemovalOfCase | 1.0 | JS|Q|∠ | Request removal of a case, only allowed for case creator (plaintiff). | ||||
| cases/resendMail | 1.0 | JS|Q|∠ | Schedule resend for a specific Case Mail Error. | ||||
| cases/resetCaseReviewers | 1.0 | JS|Q|∠ | Reset the reviewed/approved status for each reviewer on a case. | ||||
| cases/resolutionAsHTML | 1.0 | JS|Q|∠ | Get resolution as HTML. | ||||
| cases/searchExtended | 1.0 | JS|Q|∠ | Adaptive search for Cases. Compatible with DataTables. | ||||
| cases/searchPublishedCases | 1.0 | JS|Q|∠ | The service returns a subset of all published cases found, compatible with DataTables. | ||||
| cases/setAnonymizedText | 1.0 | JS|Q|∠ | Set ingress and text that represent the anonymized case. | ||||
| cases/setAttachmentAccessGroup | 1.0 | JS|Q|∠ | Set attachment's access group. Send notification if enabled | ||||
| cases/setAttachmentAvsnitt | 1.0 | JS|Q|∠ | Set attachment's avsnitt. | ||||
| cases/setAttachmentDocumentType | 1.0 | JS|Q|∠ | Set attachment's document type. Need to be allowed to update documents in the access group. | ||||
| cases/setAttachmentGroup | 1.0 | JS|Q|∠ | Configure one attachment group. | ||||
| cases/setAttachmentInternalNotes | 1.0 | JS|Q|∠ | Set attachments internal notes. | ||||
| cases/setAttachmentNr | 1.0 | JS|Q|∠ | Set attachment's nr. | ||||
| cases/setAutomated | 1.0 | JS|Q|∠ | Turn automated flag on or off using a boolean value. | ||||
| cases/setBoardMeetingDate | 1.0 | JS|Q|∠ | Set the board meeting date for a given case | ||||
| cases/setCaseDeadline | 1.0 | JS|Q|∠ | Set Case Deadline for a case | ||||
| cases/setCaseDefendant | 1.0 | JS|Q|∠ | Change case defendant ID. | ||||
| cases/setCaseField | 1.0 | JS|Q|∠ | Create or change a Case Field, delete by setting deleted=date | ||||
| cases/setCaseInformation | 1.0 | JS|Q|∠ | Update case information, using a map of field_id,value. Keys that do not exist in the input will not be changed. Returns which information fields was actually set | ||||
| cases/setCaseLegalWordpills | 1.0 | JS|Q|∠ | Set wordpills that are defined for a given case | ||||
| cases/setCasePlaintiffContact | 1.0 | JS|Q|∠ | Store or update case contact information. Plaintiff Contact is a person. Remove contact if contact is null. | ||||
| cases/setCaseResolution | 1.0 | JS|Q|∠ | Change case resolution! Returns the final resolution type (label). | ||||
| cases/setCaseResolutionNotes | 1.0 | JS|Q|∠ | Change the internal resolution notes before the resolution is approved. | ||||
| cases/setCaseStatus | 1.0 | JS|Q|∠ | Change case status. Various rules apply to case status changes. | ||||
| cases/setCaseSummaryNotes | 1.0 | JS|Q|∠ | Change the internal summary notes. | ||||
| cases/setCaseType | 1.0 | JS|Q|∠ | Update the whole case type definition. | ||||
| cases/setCaseTypeConfiguration | 1.0 | JS|Q|∠ | Set a case type configuration. | ||||
| cases/setCaseTypeExpense | 1.0 | JS|Q|∠ | Set Expense configuration for a named case Type. | ||||
| cases/setComplexity | 1.0 | JS|Q|∠ | Set the complexity of the case, as a number. Exception is thrown on errors. | ||||
| cases/setCreator | 1.0 | JS|Q|∠ | Set the case creator. Can only be used to set a person, you cannot set creator to null (no person). | ||||
| cases/setCreditedDate | 1.0 | JS|Q|∠ | Set credited date (can reset to null). Fails if this case is not to be invoiced. | ||||
| cases/setDefendantExpense | 1.0 | JS|Q|∠ | Set defendant expense configuration. | ||||
| cases/setDefendantsInternalCaseNotes | 1.0 | JS|Q|∠ | Set Defendants Internal Case Notes for a given case. The event, but not the contents, will be logged to the case log. | ||||
| cases/setInvoiceDate | 1.0 | JS|Q|∠ | Set invoice date (can reset to null). Fails if this case is not to be invoiced. | ||||
| cases/setLegalFormulation | 1.0 | JS|Q|∠ | Case Legal Evaluation Method. | ||||
| cases/setLegalQuestion | 1.0 | JS|Q|∠ | Case Legal Evaluation Method. | ||||
| cases/setLegalReason | 1.0 | JS|Q|∠ | Case Legal Evaluation Method. | ||||
| cases/setLegalRequirement | 1.0 | JS|Q|∠ | Case Legal Evaluation Method. | ||||
| cases/setLegalWordpillsForCaseType | 1.0 | JS|Q|∠ | Set configured legal word pills for a case type. | ||||
| cases/setPlaintiff | 1.0 | JS|Q|∠ | Set or change the case plaintiff person. | ||||
| cases/setPlaintiffRepresentative | 1.0 | JS|Q|∠ | Set a case representative. Index 0=representative1 1=representative2 | ||||
| cases/setResolutionFulfilled | 1.0 | JS|Q|∠ | Change fulfilled date for resolution. | ||||
| cases/setResolutionNotFulfilled | 1.0 | JS|Q|∠ | Change not fulfilled date for resolution. | ||||
| cases/shallNotBeInvoiced | 1.0 | JS|Q|∠ | This case shall not be invoiced, will block creation of billing information. | ||||
| cases/statistics | 1.0 | JS|Q|∠ | Filter cases by creation date and return Excel with case statistics. | ||||
| cases/subOrganisationsOfCaseType | 1.0 | JS|Q|∠ | Get a list of organisations below the handling organisation of the given case type. | ||||
| cases/suggestCaseResolution | 1.0 | JS|Q|∠ | Suggest case resolution. Return the suggested resolution type label. | ||||
| cases/unignoreMailError | 1.0 | JS|Q|∠ | Unignore a specific Case Mail Error. | ||||
| cases/unpublishCase | 1.0 | JS|Q|∠ | Unpublish a published case. | ||||
| cases/updateCaseEnum | 1.0 | JS|Q|∠ | Update an existing case enum. | ||||
| cases/updateCaseReviewer | 1.0 | JS|Q|∠ | Update information about a case reviewer. | ||||
| cases/updateCaseSummary | 1.0 | JS|Q|∠ | Update the case summary depending on summary state. Does not change suggested resolution. | ||||
| cases/updateCaseSummaryText | 1.0 | JS|Q|∠ | Update one case summary text. Only certain fields may be updated according to state of case. | ||||
| cases/updateContact | 1.0 | JS|Q|∠ | Update one of the case contacts. | ||||
| cases/updateDefendant | 1.0 | JS|Q|∠ | Update an existing defendant, only for ADMINs. | ||||
| cases/updateDocuments | 1.0 | JS|Q|∠ | Recreate the Draft/Final resolution document. | ||||
| cases/updateInvoice | 1.0 | JS|Q|∠ | Update an invoice and return its ID. | ||||
| cases/updateLegalEvaluationForCase | 1.0 | JS|Q|∠ | Update evaluation text for selected legal evaluation structure. | ||||
| cases/updateLegalFormulation | 1.0 | JS|Q|∠ | Case Legal Evaluation Method. | ||||
| cases/updateLegalQuestion | 1.0 | JS|Q|∠ | Case Legal Evaluation Method. | ||||
| cases/updateLegalReason | 1.0 | JS|Q|∠ | Case Legal Evaluation Method. | ||||
| cases/updateLegalRequirement | 1.0 | JS|Q|∠ | Case Legal Evaluation Method. | ||||
| cases/updateMyEvaluationDraft | 1.0 | JS|Q|∠ | Update your evaluation draft for a case. | ||||
| cases/updateReadDate | 1.0 | JS|Q|∠ | Update when the executor (as plaintiff, defendant or case worker) last read through the given case. | ||||
| cases/updateTimelineEntry | 1.0 | JS|Q|∠ | Update a timeline entry. | ||||
| cases/uploadAttachment | 1.0 | JS|Q|∠ | Upload a file, if the file already exists it will be overwritten. Return URL. | ||||
| cases/withdrawCase | 1.0 | JS|Q|∠ | Withdraw a case without any notifications. The case is withdrawn and disconnected from the plaintiff. | ||||
| configuration/get | 1.0 | JS|Q|∠ | Get a value by module,section and key. | ||||
| configuration/section | 1.0 | JS|Q|∠ | Get section of configuration | ||||
| configuration/sections | 1.0 | JS|Q|∠ | Get sections stored in a configuration module. | ||||
| configuration/set | 1.0 | JS|Q|∠ | Set a value by module,section and key. | ||||
| configureProfiling | 1.1 | JS|Q|∠ | Turn off or on service profiling. | ||||
| dialogs/create | 1.0 | JS|Q|∠ | Create a new dialog. org_id IS required. dlg_id must be -1. | ||||
| dialogs/createEntry | 1.0 | JS|Q|∠ | Create entry in a dialog. | ||||
| dialogs/delete | 1.0 | JS|Q|∠ | Delete a dialog. | ||||
| dialogs/deleteEntry | 1.0 | JS|Q|∠ | Delete entry in a dialog. | ||||
| dialogs/list | 1.0 | JS|Q|∠ | List dialogs that are available to you. | ||||
| dialogs/listEntries | 1.0 | JS|Q|∠ | List entries in a dialog. Last entry first. | ||||
| dialogs/read | 1.0 | JS|Q|∠ | Read a dialog. | ||||
| dialogs/readEntry | 1.0 | JS|Q|∠ | Read entry in a dialog. | ||||
| dialogs/update | 1.0 | JS|Q|∠ | Change a dialog. | ||||
| dialogs/updateEntry | 1.0 | JS|Q|∠ | Update entry in a dialog. Return null on failure, or the updated entry. Not all members can be changed. | ||||
| dropzone/execute | 1.0 | JS|Q|∠ | Execute import of a dropzone file | ||||
| dropzone/executionLog | 1.0 | JS|Q|∠ | Get execution log of dropzone file | ||||
| dropzone/list | 1.0 | JS|Q|∠ | List of uploaded dropzone files and status | ||||
| dropzone/remove | 1.0 | JS|Q|∠ | Delete a dropzone file | ||||
| dropzone/setAutomaticTesting | 1.0 | JS|Q|∠ | Enable or disable automatic testing of uploaded files. Returns whether this is enabled or not. | ||||
| dropzone/test | 1.0 | JS|Q|∠ | Testrun a dropzone file | ||||
| dropzone/testLog | 1.0 | JS|Q|∠ | Get test import log of dropzone file | ||||
| dropzone/upload | 1.0 | JS|Q|∠ | Upload a dropzone file. Returns number of bytes received. | ||||
| finance/enabled | 1.0 | JS|Q|∠ | Whether the finance module is enabled. | ||||
| finance/listCurrencies | 1.0 | JS|Q|∠ | Return list of currencies configured in the system. | ||||
| finance/listOccurs | 1.0 | JS|Q|∠ | Return list of legal occurs values. | ||||
| information/attachment | 1.0 | JS|Q|∠ | Get attached file extending the path by /[case_type_id]/[filename.ext]. | ||||
| information/delete | 1.0 | JS|Q|∠ | Delete an info-file. | ||||
| information/deleteByCTID | 1.0 | JS|Q|∠ | Delete an info-file by CASE TYPE ID. | ||||
| information/list | 1.0 | JS|Q|∠ | Retrieve info-files that you can view, possibly edit. | ||||
| information/notifyDefendants | 1.0 | JS|Q|∠ | Send asynchronous email notification to all VALID defendants. | ||||
| information/update | 1.0 | JS|Q|∠ | Change file parameters. | ||||
| information/updateByCTID | 1.0 | JS|Q|∠ | Change file parameters by case type id. | ||||
| information/upload | 1.0 | JS|Q|∠ | Upload a file, if the file already exists it will be overwritten. Return URL. | ||||
| jobs/dataTables | 1.0 | JS|Q|∠ | Get a ordered list for DataTables of all ServiceJobs | ||||
| jobs/delete | 1.0 | JS|Q|∠ | Delete a service job by job_id. | ||||
| jobs/get | 1.0 | JS|Q|∠ | Get a service job by ID. | ||||
| jobs/put | 1.0 | JS|Q|∠ | Create (id missing) or update (id given) a service job. Returns the ID of the service job. | ||||
| language/addLanguageToCollection | 1.0 | JS|Q|∠ | Add a new language. | ||||
| language/availableCollections | 1.0 | JS|Q|∠ | Available Text Collections. | ||||
| language/availableLabels | 1.0 | JS|Q|∠ | Available Labels. | ||||
| language/collections | 1.0 | JS|Q|∠ | Get JSON hashmap of available strings using a /<part>/<yyyymmdd>/<language>.[json] subpath. <yyyyMMdd>is in UTC. | ||||
| language/createTextCollection | 1.0 | JS|Q|∠ | Create a Text Collection. | ||||
| language/deleteLabel | 1.0 | JS|Q|∠ | Remove label by label ID. | ||||
| language/export | 1.0 | JS|Q|∠ | Download latest texts as an excel file. | ||||
| language/getAvailableLabelsForDataTable | 1.0 | JS|Q|∠ | Get a ordered list for DataTables of all case deadlines | ||||
| language/getLabel | 1.0 | JS|Q|∠ | Get a label by its ID. | ||||
| language/getLabelText | 1.0 | JS|Q|∠ | Get latest version of string from one specific collection by language and label. | ||||
| language/labelID | 1.0 | JS|Q|∠ | Get ID of Label. | ||||
| language/latest | 1.0 | JS|Q|∠ | Download latest texts as an excel file. | ||||
| language/putLabelText | 1.0 | JS|Q|∠ | Set text of label in one specific collection. | ||||
| language/setString | 1.0 | JS|Q|∠ | Set string of label in language and collection. | ||||
| language/string | 1.0 | JS|Q|∠ | Get latest version of string from collection by language and label. | ||||
| language/strings | 1.0 | JS|Q|∠ | All available Labels in this language. | ||||
| language/supportedLanguages | 1.0 | JS|Q|∠ | List of supported languages. | ||||
| language/upload | 1.0 | JS|Q|∠ | Upload a JSON hashmap of available strings to a collection/language valid from a specific date. The text collection, langauge and labels will be created if they do not exist up front. Texts that already exist with the same language/date will be overwritten. | ||||
| language/uploadCollection | 1.0 | JS|Q|∠ | Add a whole translation to a collection. Returns number of texts added. | ||||
| messages/listMessengers | 1.0 | JS|Q|∠ | List configured Messengers, only for Administrator. | ||||
| messages/remainingMessages | 1.0 | JS|Q|∠ | Remaining messages for the given messenger. | ||||
| notification/create | 1.0 | JS|Q|∠ | Create a notification for someone, return notification id. | ||||
| notification/delete | 1.0 | JS|Q|∠ | Delete a set of notifications I have (by array of notification ids). | ||||
| notification/mine | 1.0 | JS|Q|∠ | Get all notifications for me. | ||||
| reports/getParsedQuery | 1.0 | JS|Q|∠ | Validate a Query | ||||
| reports/getTableDescription | 1.0 | JS|Q|∠ | Get Table Description by name | ||||
| reports/getTables | 1.0 | JS|Q|∠ | Get Table Description by name | ||||
| serviceReset | 1.0 | JS|Q|∠ | Reset all internal cached data if possible. | ||||
| shutdown | 1.0 | JS|Q|∠ | Shutdown the service provider instance. | ||||
| statistics/dataTable | 1.0 | JS|Q|∠ | Return data tables response when searching within a provided statistics. | ||||
| statistics/excel | 1.0 | JS|Q|∠ | Return XLS response when searching within a provided statistics. | ||||
| statistics/providers | 1.0 | JS|Q|∠ | List all configured statistics providers that can be read by the executor. | ||||
| statistics/table | 1.0 | JS|Q|∠ | Return data tables response when searching within a provided statistics. | ||||
| template/createMessageTemplate | 1.0 | JS|Q|∠ | Create a new message template. | ||||
| template/current | 1.0 | JS|Q|∠ | Download current message templates as JSON file. | ||||
| template/delete | 1.0 | JS|Q|∠ | Delete existing file in the PDF templates storage. | ||||
| template/deleteMessageTemplateById | 1.0 | JS|Q|∠ | Delete message template by ID. | ||||
| template/fileList | 1.0 | JS|Q|∠ | List all files in the PDF templates storage. | ||||
| template/files | 1.0 | JS|Q|∠ | GET(read) or POST(write) files into the template structures. Must be TEXT.ADMINISTRATOR. | ||||
| template/generate | 1.0 | JS|Q|∠ | Generate PDF for template found in subpath (index.html) with parameters as input. | ||||
| template/get | 1.0 | JS|Q|∠ | Get file in the PDF templates storage. | ||||
| template/getMessageTemplate | 1.0 | JS|Q|∠ | Retreive a message template. | ||||
| template/getMessageTemplateByName | 1.0 | JS|Q|∠ | Retreive a message template by name,language,mimetype. | ||||
| template/getMessageTemplates | 1.0 | JS|Q|∠ | Get a ordered list for DataTables of all message templates. | ||||
| template/listByName | 1.0 | JS|Q|∠ | Get a ordered list of message templates by name. | ||||
| template/put | 1.0 | JS|Q|∠ | Upload (text) content to existing file in the PDF templates storage. | ||||
| template/updateMessageTemplate | 1.0 | JS|Q|∠ | Update a message template. | ||||
| template/zip | 1.0 | JS|Q|∠ | Download a ZIP structure of a folder in the PDF templates. | ||||
| updateConfigurations | 1.0 | JS|Q|∠ | Read the configuration from server_configuration and update the Service Provider. | ||||
| user/allowAccess | 1.0 | JS|Q|∠ | Allow system access for user. | ||||
| user/authenticate | 1.0 | JS|Q|∠ | Authenticate using a username and password. Return compact or extended SSO token. The compact token is the most used form (user:HASH) It will be the same within a period of time. If cookie is set, return SSO token as cookie as well. | ||||
| user/authenticated | 1.0 | JS|Q|∠ | Check if you are authenticated. | ||||
| user/changePassword | 1.0 | JS|Q|∠ | Change a users password. You must be authenticated to do so, or supply the provided secret. | ||||
| user/changeUserName | 1.0 | JS|Q|∠ | Change user user name and possibly password, may return authentication token on success (if executor _is_ the user). | ||||
| user/contact/getContact | 1.0 | JS|Q|∠ | Get my own contact information. My return null if the contact information is not set. | ||||
| user/contact/getForPerson | 1.0 | JS|Q|∠ | Get contact information for person, may return null if the contact information is not set. | ||||
| user/contact/setContact | 1.0 | JS|Q|∠ | Set my own contact information. | ||||
| user/contact/setForPerson | 1.0 | JS|Q|∠ | Set a persons contact information. | ||||
| user/createUser | 1.0 | JS|Q|∠ | Create a user with password. ADMINISTRATOR requried. | ||||
| user/denyAccess | 1.0 | JS|Q|∠ | Deny system access for user. | ||||
| user/forgotPassword | 1.0 | JS|Q|∠ | Call this to initiate a password reset for the given user. | ||||
| user/getByPerson | 1.0 | JS|Q|∠ | Get user for a person given the person_id. | ||||
| user/getCookieName | 1.0 | JS|Q|∠ | The cookie name used by this service provider instance. | ||||
| user/isRegistered | 1.0 | JS|Q|∠ | Tell if a user is registered or not. | ||||
| user/logOut | 1.0 | JS|Q|∠ | Remove the SSO cookie if set. | ||||
| user/organisation/addPersonToOrganisation | 1.0 | JS|Q|∠ | Add a person to an organisation. Authentication required. Person will become an unvalidated member. | ||||
| user/organisation/createOrganisation | 1.0 | JS|Q|∠ | Create a new organisation. Only allowed for USER_ADMINISTRATOR. | ||||
| user/organisation/deletePersonFromOrganisation | 1.0 | JS|Q|∠ | Remove a person from a given organisation. | ||||
| user/organisation/getMembershipDetails | 1.0 | JS|Q|∠ | Get additional membership information. | ||||
| user/organisation/getOrganisation | 1.0 | JS|Q|∠ | Get information about an organisation. | ||||
| user/organisation/getOrganisationByName | 1.0 | JS|Q|∠ | Get information about an organisation. Must be only organisation with that name. | ||||
| user/organisation/getOrganisations | 1.0 | JS|Q|∠ | Get an ordered list of all organisations. | ||||
| user/organisation/getOrganisationsForDataTable | 1.0 | JS|Q|∠ | Get a ordered list for DataTables of all organisations | ||||
| user/organisation/isPartOfOrganisation | 1.0 | JS|Q|∠ | Check if a person is a direct member of a specific organisation. Must be authenticated. | ||||
| user/organisation/members | 1.0 | JS|Q|∠ | Get a list of all organisation members and their roles IN that organisation. | ||||
| user/organisation/membersWithRole | 1.0 | JS|Q|∠ | Get a list of all Persons that have a certain role in an organisation. The role_name may be null. | ||||
| user/organisation/organisationPersons | 1.0 | JS|Q|∠ | Get a list of all direct members of an organization. | ||||
| user/organisation/personsOrganisations | 1.0 | JS|Q|∠ | Get all organisations that a person is a valid member of. | ||||
| user/organisation/setMembershipDetails | 1.0 | JS|Q|∠ | Set additional membership information. | ||||
| user/organisation/setMembershipValidation | 1.0 | JS|Q|∠ | Validate or in-validate a persons connection to an organisation. | ||||
| user/organisation/updateOrganisation | 1.0 | JS|Q|∠ | Update an organisation. | ||||
| user/organisation/usersOrganisations | 1.0 | JS|Q|∠ | Get all organisations that a user is connected to. If username is not provided, the executors user is used. | ||||
| user/person/deletePreferences | 1.0 | JS|Q|∠ | Delete named personal preferences. | ||||
| user/person/emailValidated | 1.0 | JS|Q|∠ | Tell when my account email was validated last. | ||||
| user/person/get | 1.0 | JS|Q|∠ | Get information about a Person. | ||||
| user/person/getByUsername | 1.0 | JS|Q|∠ | Get person ID given user name. | ||||
| user/person/getPersonsForDataTable | 1.0 | JS|Q|∠ | Get a ordered list for DataTables of all Persons. | ||||
| user/person/getPersonsUpdateContactIntervalMs | 1.0 | JS|Q|∠ | How long (seconds) a persons contact information can be untouched before the person updates or approves the contact information again. Returns number of seconds or a null value if no timeout is set. | ||||
| user/person/getPreference | 1.0 | JS|Q|∠ | Get personal option by person and name. Only the executor will be able to get the name/values. | ||||
| user/person/getPreferences | 1.0 | JS|Q|∠ | Get all personal preferences as a list. | ||||
| user/person/listNames | 1.0 | JS|Q|∠ | Retrieve a list of persons. | ||||
| user/person/listRemovalRequests | 1.0 | JS|Q|∠ | A list of persons that have successfully requested removal. | ||||
| user/person/mobilePhoneValidated | 1.0 | JS|Q|∠ | Tell when my account mobile phone number was validated last. | ||||
| user/person/myInformation | 1.0 | JS|Q|∠ | Download a JSON structure of data about me. | ||||
| user/person/putPreference | 1.0 | JS|Q|∠ | Insert or update a personal preference. | ||||
| user/person/putPreferences | 1.0 | JS|Q|∠ | Update or insert personal preferences, new preferences get the default_type. | ||||
| user/person/register | 1.0 | JS|Q|∠ | Register a new user and person in the system. | ||||
| user/person/rejectRemovePerson | 1.0 | JS|Q|∠ | Reject to remove a person that has requested removal of personal information. | ||||
| user/person/removePerson | 1.0 | JS|Q|∠ | Remove a person that has requested removal of personal information. | ||||
| user/person/requestRegistration | 1.0 | JS|Q|∠ | Second step in 2FA authentication, provide secret and received credential (PIN,code etc) to receive authentication token. Returns a valid token for the registered person. | ||||
| user/person/requestRemoval | 1.0 | JS|Q|∠ | Request removal of personal data from the system, must either be the person itself or have ADMINISTRATOR or USER_ADMINISTRATOR role for the organisation. The actual removal of personal information will be performed at a later time. | ||||
| user/person/selfRegister | 1.0 | JS|Q|∠ | First step in self-registerin in the system. If 'one_factor_authentication_is_disabled_for_user' error is returned, use requestCredential() and finally call requestRegistration(). | ||||
| user/person/unregister | 1.0 | JS|Q|∠ | Unregister a user | ||||
| user/person/updateByAdmin | 1.0 | JS|Q|∠ | Update most of an existing Persons information - with no validation or other interaction with the person. | ||||
| user/person/verifyRemovePerson | 1.0 | JS|Q|∠ | Verify if a person can be removed (by you) that has requested removal of personal information. | ||||
| user/requestAuthenticationToken | 1.0 | JS|Q|∠ | Second step in 2FA authentication, provide secret and received credential (PIN,code etc) to receive authentication token. | ||||
| user/requestCredential | 1.0 | JS|Q|∠ | Request credentials in a 2FA authentication process. Can be used to re-issue credentials as well. Returns secret that matches the PIN. | ||||
| user/requestRevalidation | 1.0 | JS|Q|∠ | Revalidate a registered users email. | ||||
| user/role/addPersonRole | 1.0 | JS|Q|∠ | Add a role to a person. | ||||
| user/role/getPersonsByRoles | 1.0 | JS|Q|∠ | Get list of all persons that have a certain role. | ||||
| user/role/getPersonsRoles | 1.0 | JS|Q|∠ | Get list of all roles for this person. Returns array of role names. | ||||
| user/role/getUsersRoles | 1.0 | JS|Q|∠ | Get list of all roles for this user. Returns array of role names. | ||||
| user/role/list | 1.0 | JS|Q|∠ | Get a list of all roles available in the system. | ||||
| user/role/removePersonRole | 1.0 | JS|Q|∠ | Add a role to a person. | ||||
| user/userExist | 1.0 | JS|Q|∠ | Check if a user exist with that user name. | ||||
| user/validateChangeUsername | 1.0 | JS|Q|∠ | Validate a user wanting to change their username, the user name and the validation secret is required. | ||||
| user/validateUsersEmailByPin | 1.0 | JS|Q|∠ | Quick validate own user and own email by providing a secret string from a received email. | ||||
| user/whoami | 1.0 | JS|Q|∠ | Who are you logged in as. Returns PublicUser, PublicPerson, roles and organisation ID's. | ||||
| wiki/INFO | 1.0 | JS|Q|∠ | Access pages/files in the space. | ||||
| wiki/VEIL | 1.0 | JS|Q|∠ | Access pages/files in the space. | ||||
| wiki/createSpace | 1.0 | JS|Q|∠ | Create a new Wiki Space. It will by default be open to anyone, public. The key must be valid and not already in use. | ||||
| wiki/deletePage | 1.0 | JS|Q|∠ | Remove a file. | ||||
| wiki/deleteSpace | 1.0 | JS|Q|∠ | Remove a space. | ||||
| wiki/getOrganisationNameForSpace | 1.0 | JS|Q|∠ | Get name of organisation for space or return null. | ||||
| wiki/getPageContent | 1.0 | JS|Q|∠ | Get page. | ||||
| wiki/hideSpace | 1.0 | JS|Q|∠ | Hide a space. | ||||
| wiki/listFiles | 1.0 | JS|Q|∠ | List all available pages in a space, without page contents. | ||||
| wiki/listSpaces | 1.0 | JS|Q|∠ | List all available spaces. | ||||
| wiki/publish | 1.0 | JS|Q|∠ | Publish or unpublish a page. | ||||
| wiki/setSpaceOrganisation | 1.0 | JS|Q|∠ | Configure organisation for this space. Organisation may be null - means the information is publicly available. | ||||
| wiki/showSpace | 1.0 | JS|Q|∠ | Show a space. | ||||
| wiki/updatePage | 1.0 | JS|Q|∠ | Update filename, mimetype and description of a page. | ||||
| wiki/updatePageContent | 1.0 | JS|Q|∠ | Update content (text data, UTF-8) of a page. | ||||
| wiki/upload | 1.0 | JS|Q|∠ | Upload a file to a space, if the file already exists it will be overwritten. Return URL. |