Skip to content

Aimsio API (1.0.0)

Introduction

Aimsio provides a set of API endpoints and supported actions to facilitate communication with external software platforms / ERPs.

Each Aimsio account can access two server options: sandbox and portal

  • sandbox is the test environment we used to implement and test configuration changes for an account before live deployment.

  • portal is the live environment where accounts store their live transactions

Authentication

Our API utilizes basic username and password authentication to access the API.

If you already have an Admin username set up for your account inside Aimsio, this can be used for API authentication. However, the best practice would be to set up a separate user for integration purposes and keep this set of credentials private only to the developer.

Aimsio users also require specific permissions to access our API. Please contact our support/integration team so they can enable the required permissions.

Throughput limitation

We currently limit API calls after calls exceed more than 10 calls per second. If our API receives too many requests (ie: if the queue takes longer than 5 seconds to return the call), the request will timeout.

Up to 10 parallel calls are permitted. We do not limit the number of sequential calls. If your organization requires more headroom to complete calls to our API, please get in touch with us.

Usage - Querying data

For most entities with GET requests supported, there are two endpoints we supported:

  • GET all objects of that type

  • GET one speficic object based on its unique identifier (GUID/Id)

When you send a GET all request, the system will return an JSON array, and each JSON contains the following properties:

  • dtype: The object type

  • guid/id: Unique identifier of the object, generated by the Aimsio system

  • updatedAt: Object's last update timestamp in epoch millseconds

Using the returned Guid or ID, you can then query each specific object from the GET single request.

Usage - Posting data

To upload data, please review the object properties and example requests for each POST endpoint.

For our Master Data endpoints, you can create/edit new entries into Aimsio system.

For some other endpoints like Invoice or Timecard, we don't allow POSTing new entries, but updating status of existing entries are supported.

Object types like NRBs or Crew/Equipment records are included in the JobOrder GET response, but have to be POSTed through their own endpoints.

  • Crew records: Employee endpoint

  • Equipment records: Equipment endpoint

  • NRB records: NRB endpoint

Download OpenAPI description
aimsio_api.json
aimsio_api.yaml
Languages
Servers
Mock server

https://api.aimsio.com/_mock/aimsio_api/

Sandbox

https://sandbox.aimsio.com/

Production

https://portal.aimsio.com/

Master Data

Operations

Job Orders

Operations

Transactions

Operations

Users

Operations

User

userGuidstring

Unique identifier and is automatically generated by Aimsio system. This is only used to update existing object

userNamestringrequired

Unique identifier, visible to end users. Required for creating or updating an object

userFirstNamestringrequired
userLastNamestringrequired
userFullNamestringread-only
userRoleNamesArray of stringsrequired

Array of valid role names. Either userRoleNames or userRoleGuids must be provided

userRoleGuidsArray of strings

Array of valid role GUIDs. Either userRoleNames or userRoleGuids must be provided

userPhonestring
userEmailstring
userIsActivebooleanrequired
userAreasArray of strings
userShortCodestring<= 3 characters
{
  "userGuid": "string",
  "userName": "string",
  "userFirstName": "string",
  "userLastName": "string",
  "userFullName": "string",
  "userRoleNames": [
    "string"
  ],
  "userRoleGuids": [
    "string"
  ],
  "userPhone": "string",
  "userEmail": "string",
  "userIsActive": true,
  "userAreas": [
    "string"
  ],
  "userShortCode": "str"
}

User

Request

Create/update new user(s). To set/reset password, use Initiate Password Reset request

Security
basicAuth
Bodyapplication/json
userListArray of objects(User)
curl -i -X POST \
  -u <username>:<password> \
  https://api.aimsio.com/_mock/aimsio_api/rest/api/standard/v1/User \
  -H 'Content-Type: application/json' \
  -d '{
    "userList": [
      {
        "userName": "testUser@kentest-sandbox",
        "userFirstName": "New",
        "userRoleNames": [
          "Field Worker"
        ],
        "userLastName": "User",
        "userPhone": "604-423-1532",
        "userEmail": "ken.bui@aimsio.com",
        "userIsActive": true
      }
    ]
  }'

Responses

Bodyapplication/json
dtypestring
Default "IntegrationImportResult"
idinteger
guidstring
importConfigurationstring
numberOfEntitiesCreatedinteger
numberOfEntitiesEditedinteger
numberOfEntitiesEditedWithErrorsinteger
numberOfEntitiesNotImportedDueToErrorsinteger
extrastring
noticesArray of objects
updatedAtinteger
importResultTypestring
numberOfEntitiesImportedinteger
Response
application/json
{
  "dtype": "IntegrationImportResult",
  "id": 0,
  "guid": "4b3f8eef-4307-4068-ba88-9ef491945122",
  "importConfiguration": null,
  "numberOfEntitiesCreated": 0,
  "numberOfEntitiesEdited": 1,
  "numberOfEntitiesEditedWithErrors": 0,
  "numberOfEntitiesNotImportedDueToErrors": 0,
  "extra": null,
  "notices": [],
  "updatedAt": 1746815305412,
  "importResultType": null,
  "numberOfEntitiesImported": 1
}

Initiate Password Reset

Request

Security
basicAuth
Bodyapplication/json
userNamestring
curl -i -X POST \
  -u <username>:<password> \
  https://api.aimsio.com/_mock/aimsio_api/rest/api/standard/v1/InitiatePasswordReset \
  -H 'Content-Type: application/json' \
  -d '{
    "userName": "testUser@kentest-sandbox"
  }'

Responses

Bodyapplication/json
dtypestring
Default "IntegrationImportResult"
idinteger
guidstring
importConfigurationstring
numberOfEntitiesCreatedinteger
numberOfEntitiesEditedinteger
numberOfEntitiesEditedWithErrorsinteger
numberOfEntitiesNotImportedDueToErrorsinteger
extrastring
noticesArray of objects
updatedAtinteger
importResultTypestring
numberOfEntitiesImportedinteger
Response
application/json
{
  "dtype": "IntegrationImportResult",
  "id": 0,
  "guid": "4b3f8eef-4307-4068-ba88-9ef491945122",
  "importConfiguration": null,
  "numberOfEntitiesCreated": 0,
  "numberOfEntitiesEdited": 1,
  "numberOfEntitiesEditedWithErrors": 0,
  "numberOfEntitiesNotImportedDueToErrors": 0,
  "extra": null,
  "notices": [],
  "updatedAt": 1746815305412,
  "importResultType": null,
  "numberOfEntitiesImported": 1
}