The following operations are available. For a formal definition, please review the Service Description.
Checks that the service is running.
Creates a Case of the specified type and variant.
If a CaseSetIdentifier is given, the Case is added to that Case Set. Otherwise a new Case Set is created. The Case will be created with an initial state of 'draft'.
When creating a GT report (TypeCode is 'gt', VariantCode is 'report'), a progress report or completion can be created simultaneously. To create a progress report, include the Case Detail named 'progress'. To create a completion, include the Case Detail named 'polluted'.
Mandatory fields include TypeCode, VariantCode, AuthorityCode, StartDateTime and EndDateTime. For mandatory fields on optional Sites and Contacts, see addSite and addContact.
Returns identifiers for created entities.
This operation is only valid for applicants.
Adds a Site to an existing Case.
This operation is only valid for the applicant in Case state 'draft' and the authority in Case state 'processing'.
Adds a Contact to an existing Case.
Mandatory fields include Addressee Type and at least one Role. Mandatory fields for any telephone numbers include TypeCode and TelephoneSubscriberIdentifier.
This operation is only valid for the applicant and only in Case state 'draft'.
Adds an attachment to the case.
If URI is set, then Content is ignored and file content is retrieved from URI using HTTP.
NEW IN 3.6! Adds geodata (shapefile, GML, WKT) to the case. Added data is available as normal attachments with a Type of 'geodata'.
Works similar to addAttachment.
NEW IN 3.2! Adds a number of detail rows to the case.
This operation is only valid for the applicant in Case state 'draft' and the authority in Case state 'processing'.
Updates the attributes of an existing Case Set.
This operation is only valid for the applicant and only on Case Sets where all Case states are 'draft'.
Updates the attributes of an existing Case.
Mandatory fields include AuthorityCode, StartDateTime and EndDateTime.
This operation is only valid for the applicant and only on Cases where Case state is 'draft'.
NEW IN 3.3! Updates StartDateTime, EndDateTime and case details of an existing Case.
StartDateTime and EndDateTime are mandatory.
This operation is only valid for the authority and only on Cases where Case state is 'processing'.
Updates the attributes of an existing Site.
This operation is only valid for the applicant in Case state 'draft' and the authority in Case state 'processing'.
Updates the attributes of an existing Contact.
Mandatory fields include Addressee Type and at least one Role. Mandatory fields for any telephone numbers include TypeCode and TelephoneSubscriberIdentifier.
This operation is only valid for the applicant and only in Case state 'draft'.
Updates the attributes of the latest progress report on an existing Case.
This operation is only valid for the applicant and only in Case state 'draft'.
Updates the attributes of the latest completion report on an existing Case.
This operation is only valid for the applicant and only in Case state 'draft'.
NEW IN 3.2! Updates the details of an existing detail row.
This operation is only valid for the applicant in Case state 'draft' and the authority in Case state 'processing'.
NEW IN 3.2! Changes the position of an existing detail row.
This operation is only valid for the applicant in Case state 'draft' and the authority in Case state 'processing'.
Removes a Site from a Case.
This operation is only valid for the applicant and only in Case state 'draft'.
Removes a Contact from a Case.
This operation is only valid for the applicant and only in Case state 'draft'.
Removes an Attachment from a Case.
This operation is only valid for the applicant.
NEW IN 3.2! Removes a detail row from a Case.
This operation is only valid for the applicant in Case state 'draft' and the authority in Case state 'processing'.
NEW IN 3.2! Removes all detail rows from a Case.
This operation is only valid for the applicant in Case state 'draft' and the authority in Case state 'processing'.
Sends all unsent Cases on a previously created Case Set to the authorities.
This will change the state of all affected Cases to 'sent'.
This operation is only valid for the applicant and will only affect Cases in Case state 'draft'.
Sends a previously created Case to the authority.
This will change the state of the Case to 'sent'.
This operation is only valid for the applicant and only in Case state 'draft'.
Acknowledges the receipt of one of a number of submissions, all relating to Cases: the Sending of a Case; the Cancellation of a Case; the Amendment of a Case; the Progress of a Case or the Completion of a Case.
Depending on the type of submission, the state of the Case will be changed in one of the following ways:
Mandatory fields include Action.
This operation is only valid for the authority and only in the Case states 'sent', 'cancelsent', 'amendsent', 'progsent' or 'compsent'.
NEW IN 3.11! Transfers a Case to another Authority.
This operation is only valid for the authority.
Cancels all Cases in a Case Set. Notifies the authorities if necessary.
Depending on the current states of the Cases, the states will be changed in one of the following ways:
This operation is only valid for the applicant and only if all Cases are in one of the Case states 'draft', 'sent', 'processing' or 'permitted'.
Cancels a Case. Notifies the authority if necessary.
Depending on the current state of the Case, the state will be changed in one of the following ways:
This operation is only valid for the applicant and only in the Case states 'draft', 'sent', 'processing' or 'permitted'.
NEW IN 3.12! Approves the requested cancellation of a Case that is past its start date.
The state of the Case will change to 'cancelled'.
This operation is only valid for the authority and only in the Case state 'cancelrec'.
NEW IN 3.12! Rejects the requested cancellation of a Case that is past its start date.
The state of the Case will change to 'permitted'.
Mandatory fields include CommentText.
This operation is only valid for the authority and only in the Case state 'cancelrec'.
Deletes a Case.
The state of the case will change to 'deleted'.
This operation is only valid for the applicant and only in the Case states 'draft', 'sent', 'rejected', 'cancelled' and 'archived'. This operation is also valid in the Case states 'cancelsent', 'amendsent', 'amendrec', 'compsent', 'completed' and 'warranty' after a period of inactivity.
Approves a Case and issues a permission document to the applicant.
Depending on the type of the Case, the state of the Case will be changed in one of the following ways:
This operation is only valid for the authority and only in the Case state 'processing'.
Rejects a Case.
The state of the Case will change to 'rejected'.
This operation is only valid for the authority and only in the Case state 'processing'.
NEW IN 3.12! Rejects a Case. This version includes the option of including documents with the rejection.
The state of the Case will change to 'rejected'.
This operation is only valid for the authority and only in the Case state 'processing'.
NEW IN 3.11! Submits an application to amend the start date and/or the end date and/or describe other changes to an approved Case.
The state of the Case will change to 'amendsent'.
Mandatory fields include StartDateTime and/or EndDateTime and/or Attachments (at least one has to be passed) as well as CommentText.
This operation is only valid for the applicant and only in the Case state 'permitted'.
NEW IN 3.9! Submits an application to amend the start date and/or the end date of an approved Case.
The state of the Case will change to 'amendsent'.
Mandatory fields include StartDateTime and/or EndDateTime (at least one has to be passed).
This operation is only valid for the applicant and only in the Case state 'permitted'.
Submits an application to amend the end date of an approved Case.
The state of the Case will change to 'amendsent'.
Mandatory fields include EndDateTime.
This operation is only valid for the applicant and only in the Case state 'permitted'.
Approves an amendment application, updating the Case with the amendment data, and issues a revised permission document to the applicant.
The state of the Case will change to 'permitted'.
This operation is only valid for the authority and only in the Case state 'amendsent'.
Rejects an amendment application, discarding the amendment data.
The state of the Case will change to 'permitted'.
This operation is only valid for the authority and only in the Case state 'amendsent'.
Sends a progress report ('temporary completion') for a Case.
The state of the Case will change to 'progsent', unless it is 'draft' in which case it won't change.
Mandatory fields include ProgressText.
This operation is only valid for the applicant and only in the Application states 'draft' (report variant only), 'permitted', 'progsent' or 'progrec'.
NEW IN 3.13! Sends a progress report ('temporary completion') for a Case.
This version includes the option of specifying completion details.
The state of the Case will change to 'progsent', unless it is 'draft' in which case it won't change.
Mandatory fields include ProgressText.
This operation is only valid for the applicant and only in the Application states 'draft' (report variant only), 'permitted', 'progsent' or 'progrec'.
Sends a completion report for a Case.
The state of the Case will change to 'archived' or 'compsent' depending on whether the Case supports completion reports.
Mandatory fields include a Detail with Name 'polluted'.
This operation is only valid for the applicant and only in the Case states 'permitted', 'progsent', 'progrec', 'restabrej' or 'issuefound'.
Approves completion of a Case, in effect closing the Case.
The state of the Case will change to 'archived'.
This operation is only valid for the authority and only in the Case states 'completed' or 'warranty'.
Rejects completion of a Case.
Under normal circumstances this could occur in one of two situations:
This operation is only valid for the authority and only in the Application states 'completed' or 'warranty'.
NEW IN 3.8! Rejects completion of a Case.
This version includes the option of specifying completion details.
Under normal circumstances this could occur in one of two situations:
This operation is only valid for the authority and only in the Application states 'completed' or 'warranty'.
Starts a warranty period for a Case. Implicitly this also acknowledges that reestablishment was approved. To approve reestablishment without starting a warranty period, use approveCompletion.
The state of the Case will change to 'warranty'.
Mandatory fields include WarrantyExpirationDate.
This operation is only valid for the authority and only in the Case state 'completed'.
Returns all of the details for a number of Case Sets.
This operation is only valid for the applicant.
Returns all of the details for a number of Cases.
This operation is valid for both the applicant and the authority.
Returns all of the details for a number of Sites.
This operation is valid for both the applicant and the authority.
Returns all of the details for a number of Contacts.
This operation is valid for both the applicant and the authority.
Returns all of the details for a number of Attachments.
This operation is valid for both the applicant and the authority.
NEW IN 3.2! Returns the list of detail rows for a Case.
This operation is valid for both the applicant and the authority.
NEW IN 3.12! Returns the current state for a Case.
This operation is valid for both the applicant and the authority.