API
Note: A dedicated API user account is required for the API to work with your committee account. Please send an email to its@iaeste.org if you wish to create an API user.
Methods
GET method
Here is an example endpoint using a GET request to export all domestic offers in a committee.
Example (try it out when you are not logged in already on the EP):
https://iaeste.smartsimple.ie/API/1/report/?username=api%2Bxa%40iaeste.org&password=TestPassword09!&apitoken=cwZhZ1xhZk5DdFNjVwd!Zm1AdlVFcHRKDjQ~&companyid=443352&reportid=30917
POST method
Endpoint: https://iaeste.smartsimple.ie/API/1/report/
Content-type: application/x-www-form-urlencoded
Parameters:
username=[username here]
password=[password here]
apitoken=cwZhZ1xhZk5DdFNjVwd!Zm1AdlVFcHRKDjQ~
companyid=443352
reportid=[function ID here]
Functions
Note: New versions of the API will have new Function IDs, so we will keep the old IDs for backwards compatibility. Make sure to use the new Function ID when there is an upgrade.
Domestic Offers
Function ID: 30917
Foreign Offers
Function ID: 31352
Result
The result is in JSON format with the following structure:
{
records: [
{
FieldName_index: "value",
...
},
...
],
header: [
{
numformat: "",
name: "FieldName",
index: "index",
type: "string"
},
...
],
message: []
}
The FieldName is a field name from the Fields section below.
The index is the index according to the order in the Fields section below. In your implementation, make sure to look through the header section for the correct index as this is not guaranteed to stay the same.
The value is the value for that field.
