Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Crisisworks has a mature web services API that provides REST and RPC access to key data and functionality.  This document provides details for system integrators to develop clients to connect, extract data and control Crisisworks.

...

To do this, first call the register API command, and supply the user credentials to retrieve a token. From then on, supplying that token to authenticated API commands will perform the command on behalf of that user.

Crisisworks account & Duty Status

The API uses a regular Crisisworks account. We recommend that this account is only used for the API, as such give it a name like API User.

...

Note the data used in this example is embedded CSV within the JSON data. If you have a CSV file, look at the next example.

Code Block
###
# Uses the asset contact import
###

POST /api/json/import

{
    "mode": "schedule",
    "dataType": "application/csv",
    "data": "Asset Code,Code Field,Title,First Name,Last Name,Company,Full Name,Address 1,Address 2,Address 3,Address 4,Email,Mobile,Phone,Registers,Notes,External ID,Relationship to Property\n43626,propnum,Mrs,Joy,Brown,ACMI Corp,,3 Bourke Street,Melbourne,VIC,3000,joy@acmicorp.com.au,0123 45667,,fpn,This is the CEO,,Owner\n43627,propnum,Mr,Fred,Smith,Datalink,,2 Foo Street,Fooville,,,fred.smith@foo.com,,,,,,\n43628,propnum,Mrs,Colleen,Davey,Colgate,,3 Elizabeth St,Melbourne,VIC,3000,colleen.davey@foo.com,,,,,,\n",
    "encoding": "plain",
    "selectedImportType": "Assets",
    "importType":"Assets",
    "importRule": "contact",
    "rollbackOnError": false,
    "message": "Test Asset Contacts import",
    "regionId": "DEV1"
}

...