API - Basic Submit

In general all API resources require below basic nodes as part of the submit structure.

Submit structure

<?xml version="1.0" encoding="UTF-8"?>
<myxml>
    <contract>
        <contractcode></contractcode>
        <username></username>
        <password></password>
        <emailonerror></emailonerror>
        <emailonwarning></emailonwarning>
    </contract>
 
    <format></format>
    <testmode></testmode>
 
    <connector>
         <application>myapplication</application>
         <webkoppel>myplugin</webkoppel>
         <development>mydevelopment</development>
         <remark>myremark</remark>
         <sourceuri>https://my.source.uri/</sourceuri>
    </connector>
</myxml>

contractcode mandatory
Unique identifier for your Acumulus account. You can have multiple username/password combinations within a single contractcode. It is suggested to create a seperate username/password for each system you are using to connect to this API.


username mandatory
Username, used for identification.


password mandatory
Password, used for identification.


emailonerror mandatory
If set, errors raised are send to this address by email. Only a single email address is allowed.


emailonwarning mandatory
If set, warnings raised are send to this address by email. Only a single email address is allowed.


format
A case insensitive optional parameter to define in which type of format you would like to receive the response.

Option
Output format
 
json
JSON
 
xml
XML
DEFAULT

testmode
Only available in resources when explicitly mentioned. Please refer to call-specific documentation.
Numeric identifier for applying testmode. When using testmode no changes are put into Acumulus but your input is being checked for warnings and errors.

Option
Behavior
 
0
Normal run
DEFAULT
1
No changes are made.