If you leave out the version, the current version of the service will be called.
Input:
case_typeoptional CaseType
allow_missing_plaintiff_email_in_quick_create boolean (Whether plaintiffs email is allowed to be missing when a case is quick-created. The plaintiff will not be able to log in to this case.)
always_new_tab boolean (When clicking on a case in case list, open the case in a new tab.)
assign_case_worker boolean
assign_to_case_administrators boolean
automatic_review boolean (Force board reviewers to review the case again if any of the boards texts change. The reviewers are set to unreviewed, unapproved.)
board_meeting_date_overrides_resolution_date boolean (When a case is resolved (not closed), the board meeting date will be used as the resolution date if it is present.<p/>Developed for RfE.)
can_complain_orally boolean (This only controls the visibility of one question in the case. Have been replaced by case fields, and will be removed in subsequent releases.)
can_edit_plaintiffs_personal_data boolean (Case workers can edit plaintiffs personal data in a case or plaintiffs personal data directly.)
case_prefix String (This is how a case is prefixed when creating case numbers. It can be formatted using these specifiers:<ul><li>{yyyy} 4 digit year<li>{mm} 2 digit month, 01 is January<li>{nnn} 3 digit increasing case number, the serial<li>{nnnn} 4 digit increasing case number, the serial</ul>)
case_url_prefix String (The base URL for opening a case, given the case_id. Used for urls in sending emails etc.)
case_administrator_can_assign_defendant_case_workers boolean (Used by user interface to provide functionality to assign defendant case workers to a case. Without this, only the defendant can assign their own case workers for a case.)
case_administrator_can_remove_cases boolean (Allow the case administrator to fully remove a case, with no trace in the system.<p/>Developed for TKN/RfE. A case can be still removed if it's requested to be removed or have deleted date set!)
caseadmin_can_delete_uploads boolean (Whether the case administrator can delete any attachment on a case at any given time. This option will be removed in later releases as it is controlled by attachment group rights.)
caseworker_can_remove_withdrawn_cases boolean (Allow case workers to remove cases that the plaintiff want to withdraw. The case is disconnected from the plaintiff and personal information is removed. Then the case is deleted.)
SSOoptional String
Optional SSO token for authentication.
Allowed HTTP Methods:
POST
Accept types:
application/json
application/xml
application/x-www-form-urlencoded
multipart/form
Accept charsets:
UTF-8
ISO-8859-1
LATIN1
Output:
200 OK response type CaseType:
allow_missing_plaintiff_email_in_quick_create boolean (Whether plaintiffs email is allowed to be missing when a case is quick-created. The plaintiff will not be able to log in to this case.)
always_new_tab boolean (When clicking on a case in case list, open the case in a new tab.)
assign_case_worker boolean
assign_to_case_administrators boolean
automatic_review boolean (Force board reviewers to review the case again if any of the boards texts change. The reviewers are set to unreviewed, unapproved.)
board_meeting_date_overrides_resolution_date boolean (When a case is resolved (not closed), the board meeting date will be used as the resolution date if it is present.<p/>Developed for RfE.)
can_complain_orally boolean (This only controls the visibility of one question in the case. Have been replaced by case fields, and will be removed in subsequent releases.)
can_edit_plaintiffs_personal_data boolean (Case workers can edit plaintiffs personal data in a case or plaintiffs personal data directly.)
case_prefix String (This is how a case is prefixed when creating case numbers. It can be formatted using these specifiers:<ul><li>{yyyy} 4 digit year<li>{mm} 2 digit month, 01 is January<li>{nnn} 3 digit increasing case number, the serial<li>{nnnn} 4 digit increasing case number, the serial</ul>)
case_url_prefix String (The base URL for opening a case, given the case_id. Used for urls in sending emails etc.)
case_administrator_can_assign_defendant_case_workers boolean (Used by user interface to provide functionality to assign defendant case workers to a case. Without this, only the defendant can assign their own case workers for a case.)
case_administrator_can_remove_cases boolean (Allow the case administrator to fully remove a case, with no trace in the system.<p/>Developed for TKN/RfE. A case can be still removed if it's requested to be removed or have deleted date set!)
caseadmin_can_delete_uploads boolean (Whether the case administrator can delete any attachment on a case at any given time. This option will be removed in later releases as it is controlled by attachment group rights.)
caseworker_can_remove_withdrawn_cases boolean (Allow case workers to remove cases that the plaintiff want to withdraw. The case is disconnected from the plaintiff and personal information is removed. Then the case is deleted.)
4XX Client Error Response {data:<Error string>} Usually wrong usage by the client.
5XX Server Error Response {data:<Error string>} Exception, error in the service.
Additional comments:
setCaseType is automatically provided using method reflection.
This service is implemented using the Albicore:SimplifiedService framework.
How to call this service:
POST JSON in body: { }
POST urlencoded in body:
POST multipart/form, encode parameters as parts.
About output:
200 OK All valid service executions will return OK response.