DELETE Screen

TABLE OF CONTENTS

• Parameters
• Example

The DELETE Screen Form API allows you to delete an existing form screen.

This allows you to delete specific screens from the platform as required, from various 3rd party systems, for whatever reason.

On the Cloud, this API is available via SSL-secured HTTPS connection using the REST DELETE verb.
The format query string parameter controls the desired response format.  Specify either XML or JSON.

/api/v2/screen/form?format=xml/json

You may use either JSON or XML formats in your DELETE request.
You indicate this by setting the ContentType HTTP header as "application/json" or "application/xml".

If no ContentType is specified, XML format is assumed.

All XML formatted requests must specify the following XML namespace in the data source root element:
xmlns:i="http://www.w3.org/2001/XMLSchema-instance"

---

Parameters

The required parameters for a DELETE request to the Screens API are outlined below.

Name	Type	Description	Required
Id	String	The unique identifier (GUID) of the Form to delete.	✓
ExternalId	String	The External identifier of the form to delete.
Version	Integer	The version of the screen to delete when using ExternalId.
Status	String	The status of the screen to delete when using ExternalId.
TrashAllVersions	Boolean	Whether only the latest/specified version or all versions of this form will be deleted.
CompanyId	Integer	Your unique Company Id found on the Organisation Setup page of the secure website.	✓
IntegrationKey	String	Your unique Integration Key found on the Organisation Setup page of the secure website.	✓

---

Example

Given that the API is REST-based, you can access the API directly via your web browser to test or by using Postman API Platform.

Request URL

https://eforms.mobileform.net:443/api/v2/screen/form?CompanyId=6XXXX&IntegrationKey=995XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

HTML

Request Body

{
    "Id": "28fXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    "ExternalId": "",
    "Status": "",
    "TrashAllVersions": true,
    "CompanyId": 6XXXX,
    "IntegrationKey": "995XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
  }

---

• Related Articles

• PUT Screen

  TABLE OF CONTENTS Parameters Example The PUT Screen Form API allows you to update an existing form screen. Enables scenarios where 3rd party systems can make edits/changes to forms for whatever reason. Everything from form name, description, fields, ...

• GET Screen (Listing Screen Search)

  TABLE OF CONTENTS Parameters Example The GET Screen (Listing Screen Search) API returns the Published version of the matching Listing Screen or all versions of a specified Listing Screen. On the Cloud, this API is available via SSL-secured HTTPS ...

• GET Screen (Details Screen Search)

  The GET Screen (Details Screen Search) API endpoint returns the Published version of matching Detail Screens or all versions of a single specified Detail Screen. On the Cloud, this API is available via SSL-secured HTTPS connection using the REST GET ...

• POST Screen

  TABLE OF CONTENTS Parameters Example The POST Screen Form API allows you to create a form programmatically rather than in the designer. On the Cloud, this API is available via SSL-secured HTTPS connection using the REST POST verb. The format query ...

• DELETE User

  DELETE Request The DELETE verb allows you to delete a single User. Our platform will immediately remove the User from the platform. You may use either JSON or XML formats in your request. You indicate this by setting the ContentType HTTP header as ...