<< Click to Display Table of Contents >> Navigation: API requests > Get aspects |
API request
Name: GetAspects
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:GetAspects xmlns:ns2="api.timewriter.nl"> <securityToken></securityToken> <aspectType></aspectType> <filters> <filter> <field></field> <operator></operator> <value></value> </filter> ... </filters> </ns2:GetAspects> </S:Body> </S:Envelope> |
Explanation
Tag/field name |
Type |
Remark |
Description |
securityToken |
string |
mandatory |
securityToken obtained at log in |
aspectType |
mandatory Must have a value from AspectType or use * to get all aspects. |
aspecttype |
|
filters |
List<Filter> |
optional Apart from the aspectType filter this filter can be used for filtering on specific aspect fields. |
filter list for Aspect fields (check Response structure and Explanation below) See also Filter For only fetching the changed data check the: Filter -> Example |
Limit
A maximum of 10000 aspects can be returned per request.
If the request will yield more than 10000 aspects, no aspects will be returned and it will be reported in the errorMessage field of the response.
Examples
This example will get all Aspects with a AspectType IT_MED (employees):
|
This example will get all Aspects:
|
API response
Name: GetAspectsResponse
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:GetAspectsResponse xmlns:ns2="api.timewriter.nl"> <result> <error></error> <errorMessage></errorMessage> <aspectList> <aspect> <id></id> <aspectType></aspectType> <name></name> <category></category> <abbreviation></abbreviation> <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> ... </aspectList> </result> </ns2:GetAspectsResponse> </S:Body> </S:Envelope> |
Explanation
Tag/field name |
Type |
||||||||||||
result |
RequestResult
|