Description: This endpoint will delete the most recent version of every form in a form collection. Forms already in Filed cannot be deleted.
API Name: /Forms/Delete
HTTP Method: Delete
HTTP Status Codes:
| HTTP Status Codes | Description | Example | |
|---|---|---|---|
| 1 | 200 | Ok | No response |
| 2 | 400 | Bad Request | A validation has failed (like Form in Filed) |
| 3 | 404 | Not Found | FormID not found |
| 4 | 500 | Internal server error | Internal or business error exception |
API Request
| Request Parameter | DataType | Validations | Mandatory | Description | |
|---|---|---|---|---|---|
| 1 | request | List of GUID's | Not null object | Yes | List of form Id |
FormsDeleteRequest/FormIds
| Request Parameter | DataType | Validations | Mandatory | Description | |
|---|---|---|---|---|---|
| 1 | FormId | Guid | Valid Guid value. Not null or empty | Yes | Form Id |
API Response No content
Example
/// OK example [200]
///
/// DELETE /api/Forms/Delete
/// {
/// "response": null
/// "status": "OK",
/// "errors": null
/// }
///
/// Bad Request example [400]
///
/// {
/// "Data": null,
/// "Status": "Failure",
/// "Errors": [{
/// "Code": "400",
/// "Message": "FormID de8bfb7c-d5cf-4e78-acb5-c07aca000bbf in Filed",
/// "Detail": null,
/// "Type": null,
/// "TraceId": null,
/// "ValidationErrors": [{
/// "Field": "formId",
/// "Code": 400,
/// "Message": "FormID de8bfb7c-d5cf-4e78-acb5-c07aca000bbf in Filed"
/// }
/// ]
/// }
/// ]
/// }
///
/// Not Found example [404]
///
/// {
/// "response": null,
/// "status": "Failure",
/// "errors": [
/// {
/// "code": "404",
/// "message": "FormID 673bde9e-5e99-4d10-a8ae-1fb9453f1627 not found",
/// "detail": "",
/// "type": "",
/// "traceId": "",
/// "validationErrors": []
/// }
/// ]
/// }
1. Consider you want to delete an existing form that is not having the “filed “status for a specific account.
2. User will require following information to Delete API: LFEId, UserId, one valid form id for a form that is not having “filed” status (status 6).
3. To execute the API request, user requires bearer token as well as an authorization, for the token the OAuth 2.0 type of authorization is required. If user do not hold the bearer token, then the user does not have permission to execute the API request.
4. It is required an LFEId, UserId in the headers column and a valid form id inside the body
5.The request body will look like this:
///[
///"Form Id”
///]
6.When user execute the valid API request, he gets the response in the following format
///{
/// "response": null,
/// "status": "OK",
/// "errors": null
///}
7.Value 3 should be added to the column “ActionId” in the “ClientFormVersion” table.
8.A new record should be added in the “ClientFormHistory” table for the deleted Form and in the column “ActionId” should be added value as 3.
1. Consider you want to delete multiple existing forms that are not having the “filed “status for a specific account.
2. User will require following information to Delete API: LFEId, UserId, two or more valid form ids for forms that are not having “filed” status (status 6).
3. To execute the API request, user requires bearer token as well as an authorization, for the token the OAuth 2.0 type of authorization is required. If user do not hold the bearer token, then the user does not have permission to execute the API request.
4. It is required an LFEId, UserId in the headers column and a valid form ids inside the body.
5. The request body will look like this:
///[
///"Form Id”,
///"Form Id”
///]
6. When user execute the valid API request, he gets the response in the following format:
///{
/// "response": null,
/// "status": "OK",
/// "errors": null
///}
7. Value 3 should be added to the column “ActionId” in the “ClientFormVersion” table for each of the deleted form.
8. A new record should be added in the “ClientFormHistory” table for the deleted forms and in the column “ActionId” should be added value as 3 for each of the deleted form.
1. Consider you want to delete multiple forms, as part of the list of form ids sent as parameter some of the form ids exist on the database and some other don’t exist for specific account.
2. User will require following information to Delete API: LFEId, UserId, two or more form (at least 1 existing form id and 1 not existing form id).
3. To execute the API request, user requires bearer token as well as an authorization, for the token the OAuth 2.0 type of authorization is required. If user do not hold the bearer token, then the user does not have permission to execute the API request.
4. It is required an LFEId, UserId in the headers column and a valid form ids inside the body.
5. The request body will look like this:
///[
///"Valid existing form id”,
///“Not existing form id”
///]
6. When user execute the valid API request, he gets the response in the following format:
///{
/// "response": null,
/// "status": "Failure",
/// "errors": [
/// {
/// "code": "404",
/// "message": "FormID “form id” not found",
/// "detail": "",
/// "type": "",
/// "traceId": "",
/// "validationErrors": []
/// }
/// ]
///}
7. Value 3 should not be added to the column “ActionId” in the “ClientFormVersion” table for any of the form ids added to the body.
8 A new record should not be added to the “ClientFormHistory” table for any of the form ids added to the body.
1. Consider you want to delete an existing form that is having the “filed “status for a specific account.
2. User will require following information to Delete API: LFEId, UserId, one valid form id for a form that is having “filed” status (status 6).
3. To execute the API request, user requires bearer token as well as an authorization, for the token the OAuth 2.0 type of authorization is required. If user do not hold the bearer token, then the user does not have permission to execute the API request.
4. It is required an LFEId, UserId in the headers column and a valid form id inside the body.
5. The request body will look like this:
///[
///"Valid existing form id with filed status”
///]
6. When user execute the valid API request, he gets the response in the following format:
///{
/// "response": null,
/// "status": "Failure",
/// "errors": [
/// {
/// "code": "400",
/// "message": "FormID “Form Id” in Filed",
/// "detail": null,
/// "type": null,
/// "traceId": null,
/// "validationErrors": []
/// }
/// ]
///}
7. Value 3 should not be added to the column “ActionId” in the “ClientFormVersion” table for the form id added to the body.
8. A new record should not be added to the “ClientFormHistory” table for any of the form ids added to the body.
1. Consider you want to delete multiple existing forms, as part of the list of form ids sent as parameter some of the form have valid status and some others are having the “filed” status
2. User will require following information to Delete API: LFEId, UserId, two or more form (at least 1 form id for a form with valid status and 1 form id for a form with invalid status)
3. To execute the API request, user requires bearer token as well as an authorization, for the token the OAuth 2.0 type of authorization is required. If user do not hold the bearer token, then the user does not have permission to execute the API request.
4. It is required an LFEId, UserId in the headers column and a valid form ids inside the body.
5. The request body will look like this:
///[
///"Existing form id with valid status”,
///“Existing form id with filed status”
///]
6. When user execute the valid API request, he gets the response in the following format:
///{
/// "response": null,
/// "status": "Failure",
/// "errors": [
/// {
/// "code": "400",
/// "message": "FormID “Form Id 1”, “Form Id 2” in Filed",
/// "detail": null,
/// "type": null,
/// "traceId": null,
/// "validationErrors": []
/// }
/// ]
///}
7. Value 3 should not be added to the column “ActionId” in the “ClientFormVersion” table for any of the form ids added to the body.
8. A new record should not be added to the “ClientFormHistory” table for any of the form ids added to the body.