Delete aspects

<< Click to Display Table of Contents >>

Navigation:  API requests >

Delete aspects

API request

Name: DeleteAspect

 

API request structure

<?xml version="1.0" encoding="UTF-8"?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">

<SOAP-ENV:Header/>

<S:Body>

  <ns2:DeleteAspect xmlns:ns2="api.timewriter.nl">

    <securityToken></securityToken>

    <id></id>

  </ns2:DeleteAspect>

</S:Body>

</S:Envelope>

 

Explanation

Tag/field name

Type

Remark

Description

securityToken

string

mandatory

securityToken obtained at log in

id

long

mandatory

aspect id

 

Examples

hmtoggle_arrow1Delete aspect

 

This example will delete aspect with id 123456.

<?xml version="1.0" encoding="UTF-8"?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">

<SOAP-ENV:Header/>

<S:Body>

  <ns2:DeleteAspect xmlns:ns2="api.timewriter.nl">

    <securityToken></securityToken>

    <id>123456</id>

  </ns2:DeleteAspect>

</S:Body>

</S:Envelope>

 

 

API response

Name: DeleteAspectResponse

 

API response structure

<?xml version="1.0" encoding="utf-8"?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">

<SOAP-ENV:Header/>

<S:Body>

  <ns2:DeleteAspectResponse xmlns:ns2="api.timewriter.nl">

    <result>

      <error></error>

      <errorMessage></errorMessage>

      <success></success>

    </result>

  </ns2:DeleteAspectResponse>

</S:Body>

</S:Envelope>

 

Explanation

Tag/field name

Type

result

RequestResult

Tag/field name

Type

Description

error

boolean

false if there are no errors, true if there are errors

errorMessage

string

error message, only used when error = true

success

boolean

true if successfully deleted, false if failed

 

Remark

The following only applies to aspects: To prevent data from being lost, an aspect is not really deleted, but given a deleted marking. The aspect can no longer be used or requested but is still present in the bookings history and reports.