Ping
This is a system wide call and does not rely on a company, hence you can query it using a Company code of -1 as a placeholder, knowing that it is not validated. It also has no menu dependency and can be called by any valid user. Its primary purpose is a means to check the API is up and running.
URL | Verbs | Function |
|---|---|---|
/Ping | GET | Return basic information to verify the API is responding |
Security Linked Menu
N/A | N/A |
Supported modifiers
includeUserCompanies | Include a list of allowed Companies for the API user | includeUserCompanies=true | 2020.2 |
Sample XML Response
<?xml version="1.0" encoding="UTF-8"?>
<Ping>
<SerialNo>4</SerialNo>
<GreentreeVersion>2019.5-2</GreentreeVersion>
<ServerTimeStamp>2020-03-24T07:17:01</ServerTimeStamp>
<Companies collection='true' count='7'>
<Company>
<Code>01</Code>
<Name>e-Computers - Australia</Name>
<IsDefault>true</IsDefault>
</Company>
<Company>
<Code>02</Code>
<Name>e-Computers - Canada</Name>
</Company>
<Company>
<Code>05</Code>
<Name>e-Computers - USA</Name>
</Company>
<Company>
<Code>06</Code>
<Name>e-Computers - NZ</Name>
</Company>
<Company>
<Code>07</Code>
<Name>e-Computers - UK</Name>
</Company>
<Company>
<Code>08</Code>
<Name>e-Computers - Ireland</Name>
</Company>
<Company>
<Code>09</Code>
<Name>e-Consolidations - Australasia</Name>
</Company>
</Companies>
</Ping