Follow

DELETE Task

The Tasks API allows you to retrieve, create and delete Tasks on the platform. 
This enables scenarios where jobs created/maintained in other systems (e.g. SAP, Salesforce) can be delivered through to your app users automatically.

Any new Task created will be automatically synchronized to the target User’s devices.  

On the Cloud this API is available via SSL secured HTTPS connection using the REST GET, POST and DELETE verbs:

https://secure.formsonfire.com/api/v1/stask?format=[xml|json]

To search for and retrieve multiple Tasks at once, use a GET with the search API found at:

https://secure.formsonfire.com/api/v1/stask/search?format=[xml|json]

The format query string parameter controls the desired response format.  Specify either xml or json.

DELETE Request

The DELETE verb allows you to delete a single Task that has not yet been completed.  The platform will immediately remove the Task from the assigned User.

You may use either JSON or XML formats in your 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.

The required and optional parameters for a DELETE to the Tasks API are outlined below.

Parameter Name

Data Type

Required

Description

STask

STask

Yes

The Task that you wish to create.  See the STask type definition from the GET above.

 

STask (<STask>) Required Fields
The following fields must be specified when issuing a POST request to the STask API.
All other fields are optional.  Task completion fields (e.g. Status, ActualCompleteLat) will be ignored.

Field Name

Data Type

Description

IntegrationKey

String

Your unique Integration Key found on the Organization Setup page of the secure website (under My Account)

ProviderId

Integer

Your unique Provider Id found on the Organization Setup page of the secure website (under My Account)

Id

GUID

Unique identifier of the Task.  You would have received this when creating the Task via POST.

 

DELETE Response

If the DELETE update is successful, a 200 HTTP status is returned with an empty response.
If the DELETE is unsuccessful, a 400 HTTP status is returned along with a STaskResponse.

STask Response (<STaskResponse>)

Field Name

Data Type

Description

ResponseStatus

ResponseStatus

Details of any errors that may have occurred

 

 

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.
Powered by Zendesk