Add/Update aspects

<< Click to Display Table of Contents >>

Navigation:  API requests >

Add/Update aspects

API request

Name: UpdateAspect

 

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:UpdateAspect xmlns:ns2="api.timewriter.nl">

    <securityToken></securityToken>

    <aspect>

      <id></id>

      <aspectType></aspectType>

      <name></name>

      <category></category>

      <abbreviation></abbreviation>

      <loginName></loginName>

      <password></password>

      <overhead></overhead>

      <validFrom></validFrom>

      <validTo></validTo>

      <notForAccess></notForAccess>

      <notForAuthorizations></notForAuthorizations>

      <notForCombinations></notForCombinations>

      <notForTariffAgreements></notForTariffAgreements>

      <notForBudgets></notForBudgets>

      <notForProgramModules></notForProgramModules>

      <taskData>

        <no></no>

        <groupId></groupId>

        <description></description>

        <closed></closed>

        <budget></budget>

        <invoiceable></invoiceable>

        <useInvoicing></useInvoicing>

        <invoiceType></invoiceType>

        <price></price>

        <recurringPattern>

          <start></start>

          <end></end>

          <type></type>

          <frequency></frequency>

        </recurringPattern>

        <id_GR_MED></id_GR_MED>

        <id_IT_AT1></id_IT_AT1>

        <id_IT_AT2></id_IT_AT2>

        <id_IT_AT3></id_IT_AT3>

        <id_IT_AT4></id_IT_AT4>

        <id_IT_AT5></id_IT_AT5>

      </taskData>

      <invoiceData>

        <address></address>

        <postalCode></postalCode>

        <city></city>

        <countryCode></countryCode>

        <contact></contact>

        <email></email>

        <debtorId></debtorId>

        <reference></reference>

        <debtorLedgerAccountCode></debtorLedgerAccountCode>

        <turnoverLedgerAccountCode></turnoverLedgerAccountCode>

      </invoiceData>

      <userFieldList>

        <userField>

          <key></key>

          <value></value>

        </userField>

         ...

      </userFieldList>

    </aspect>

  </ns2:UpdateAspect>

</S:Body>

</S:Envelope>

 

Explanation

Tag/field name

Type

Remark

Description

securityToken

string

mandatory

securityToken obtained at log in

aspect

Aspect

mandatory

see Aspect

 

Examples

hmtoggle_arrow1Add aspect

 

This example will create a new aspect:

<?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:UpdateAspect xmlns:ns2="api.timewriter.nl">

    <securityToken></securityToken>

    <aspect>

      <id></id> <!-- id has no value: create new aspect -->

      <aspectType>IT_AT1</aspectType>

      <name>New customer</name>

    </aspect>

  </ns2:UpdateAspect>

</S:Body>

</S:Envelope>

 
hmtoggle_arrow1Update aspect

 

This example will change the name of the 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:UpdateAspect xmlns:ns2="api.timewriter.nl">

    <securityToken></securityToken>

    <aspect>

      <id>123456</id> <!-- id has got a value: aspect with id 123456 will be updated -->

      <aspectType>IT_AT1</aspectType>

      <name>New name</name>

    </aspect>

  </ns2:UpdateAspect>

</S:Body>

</S:Envelope>

 

 

API response

Namw: UpdateAspectResponse

 

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:UpdateAspectResponse xmlns:ns2="api.timewriter.nl">

    <result>

      <error></error>

      <errorMessage></errorMessage>

      <aspect>

        <id></id>

        <aspectType></aspectType>

        <name></name>

        <category></category>

        <abbreviation></abbreviation>

        <loginName></loginName>

        <overhead></overhead>

        <validFrom></validFrom>

        <validTo></validTo>

        <notForAccess></notForAccess>

        <notForAuthorizations></notForAuthorizations>

        <notForCombinations></notForCombinations>

        <notForTariffAgreements></notForTariffAgreements>

        <notForBudgets></notForBudgets>

        <notForProgramModules></notForProgramModules>

        <taskData>

          <no></no>

          <groupId></groupId>

          <description></description>

          <closed></closed>

          <budget></budget>

          <invoiceable></invoiceable>

          <useInvoicing></useInvoicing>

          <invoiceType></invoiceType>

          <price></price>

          <recurringPattern>

            <start></start>

            <end></end>

            <type></type>

            <frequency></frequency>

          </recurringPattern>

          <id_GR_MED></id_GR_MED>

          <id_IT_AT1></id_IT_AT1>

          <id_IT_AT2></id_IT_AT2>

          <id_IT_AT3></id_IT_AT3>

          <id_IT_AT4></id_IT_AT4>

          <id_IT_AT5></id_IT_AT5>

        </taskData>

        <invoiceData>

          <address></address>

          <postalCode></postalCode>

          <city></city>

          <contact></contact>

          <email></email>

          <debtorId></debtorId>

          <reference></reference>

          <debtorLedgerAccountCode></debtorLedgerAccountCode>

          <turnoverLedgerAccountCode></turnoverLedgerAccountCode>

        </invoiceData>

        <userFieldList>

          <userField>

            <key></key>

            <value></value>

          </userField>

           ...

        </userFieldList>

      </aspect>

    </result>

  </ns2:UpdateAspectResponse>

</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

aspect

Aspect

see Aspect