Fire Department REST API

Schema

All API access is over HTTPS, and accessed through https://sizeup.firstduesizeup.com/fd-api/v1/. All data is sent and received as JSON.

All timestamps are returned in ISO 8601 format:

YYYY-MM-DDTHH:MM:SSZ

Parameters

For POST request, parameters not included in the URL should be encoded as JSON with a Content-Type of 'application/json'.

Root Endpoint

https://sizeup.firstduesizeup.com/fd-api/v1/

HTTP Verbs

Where possible, API v1 strives to use appropriate HTTP verbs for each action.

Authentication

Requests that require authentication will return 403 Forbidden.

OAuth2 Token (sent in a header)

$ curl -H "Authorization: Bearer OAUTH-TOKEN" https://sizeup.firstduesizeup.com/fd-api/v1/foo/bar

This should only be used in server to server scenarios. Don't leak your OAuth application's client secret to your users.

Timezones

We use UTC as the timezone to create the item.

API Methods

POST /fd-api/v1/auth/token

Get an Access Token.

POST /fd-api/v1/auth/token

Parameters

Example Request

$ curl -i -k -H "Content-Type: application/json" -X POST -d '{"grant_type": "client_credentials", "email": "user1@fdsu.tld", "password": "password1"}' https://sizeup.firstduesizeup.com/fd-api/v1/auth/token

Success Response

HTTP/1.1 200 OK
{
  "access_token": "AAJEdz1tzkHFn6b76rj9SPAmE4BDCxRI",
  "expires_in": 1209600,
  "scope": "api web",
  "token_type": "bearer"
}

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Incorrect email\/password combination."
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": "Validation Failed. Please provide grant_type parameter.",
  "errors": [
    {
      "field": "grant_type",
      "code": "missing_field",
      "message": "Please provide grant_type parameter."
    }
  ]
}

POST /fd-api/v1/dpt/run-parser

Run the dispatch parser template engine. Requires authentication via Bearer token. Request body must be JSON containing a dispatch parser template identical to the ones that are generated by the CAD-AI tool and the ones stored in docs/parser_templates/. Response is JSON.

POST /fd-api/v1/dpt/run-parser

Parameters

no parameter. The body is just a JSON-encoded string (the dispatch parser template). The structure of the DPT required that the top level key of the json is "templates"

Example Request

$ curl -i -k -H "Authorization: Bearer YOUR_ACCESS_TOKEN" -H "Content-Type: application/json" -X POST -d '{
  "templates": [
    {
      "name": "Central Square Email Abington MA",
      "cad_vendor": "Central Square",
      "data_source": "email\/text",
      "parser_type": "regex",
      "status_code": "enabled",
      "version": "2",
      ...
      "example_data": [],
      "parser_options": {},
      "transformations": {},
      ...
      "batt_depts": [
        1234,
        2345
      ]
    }
  ]
}' https://sizeup.firstduesizeup.com/fd-api/v1/dpt/run-parser

Success Response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "result": {
    "<battDeptId1>": {
      "<exampleName1>": {
        "afterParser": <GenericParseResult object>,
        "afterTransform": <GenericParseResult object>,
        "modelErrors": [],
        "error": "",
        "isParsed": true,
        "parsingTime": "00m:00s.000ms",
        "transformingTime": "00m:00s.000ms"
      },
      ...
    },
    ...
  }
}

• result: Object keyed by battalion department ID. Each value is an object keyed by example name; each entry is a parser result (see below).
• Parser result (per example): afterParser (GenericParseResult after parsing), afterTransform (GenericParseResult after transformations), modelErrors (array of validation errors), error (string, set on exception), isParsed (boolean), parsingTime, transformingTime (elapsed time strings).

GenericParseResult object structure

The run-parser success response includes one or more GenericParseResult objects (or a wrapper containing them). Each object has the following attributes. All fields are optional in the JSON; omitted keys mean the value was not set or is empty.

Dispatch fields (map to dispatch object attributes):

NFIRS notification fields (map to nfirs notification object attributes):

Control and metadata fields:

Apparatus item structure (each element of apparatus):

Personnel item structure (each element of personnelItems within an apparatus):

Example minimal structure:

{
  "dispatchType": "TYPE",
  "callNotes": "Notes",
  "address": "123 Main St",
  "city": "City",
  "stateCode": "NY",
  "originalMessage": "...",
  "latitude": 40.0,
  "longitude": -74.0,
  "incidentTypeCode": "118CR",
  "battDeptId": 1,
  "xrefId": "REF-1",
  "placeName": "Place",
  "unit": "",
  "dispatchUnitCodes": [],
  "crossStreets": "",
  "statusCode": "open",
  "nfirsIncidentNumber": "",
  "locationInfo": "",
  "venue": "",
  "callerName": "",
  "radioChannel": "",
  "addressRelStatusCode": "",
  "zipCode": "",
  "errors": [],
  "notes": [],
  "extraFields": {},
  "isNewRecord": true,
  "processDispatch": true,
  "processNfirsNotification": true,
  "isOnlyForUpdate": false,
  "isIgnored": false,
  "isNotification": false,
  "isMatch": true,
  "notProcessReasons": [],
  "updateRules": [],
  "fieldConstraints": {},
  "apparatus": [
    {
      "unitCode": "E101",
      "isAid": false,
      "dispatchedAt": "2025-02-03T14:00:00Z",
      "dispatchAckAt": null,
      "enroutedAt": null,
      "arrivedStagingAt": null,
      "arrivedAt": null,
      "leavedSceneAt": null,
      "clearedAt": null,
      "backInServiceAt": null,
      "backHomeLocationAt": null,
      "canceledAt": null,
      "arrivedDestinationLandingAreaAt": null,
      "patientArrivedDestinationAt": null,
      "destinationPatientTransferCareAt": null,
      "personnelItems": [
        {
          "firstName": "Jane",
          "lastName": "Doe",
          "middleInitial": "M",
          "agencyId": "AG-001",
          "xrefId": "PERS-001"
        }
      ]
    }
  ],
  "isApparatusMultiDocEnabled": false,
  "apparatusMultipleCriteriaField": null
}

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": "Validation Failed. Please provide templates parameter.",
  "errors": [
    {
      "field": "templates",
      "code": "missing_field",
      "message": "Please provide templates parameter (JSON-encoded string)."
    }
  ]
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": "Validation Failed. Templates must be valid JSON.",
  "errors": [
    {
      "field": "templates",
      "code": "invalid",
      "message": "Templates must be a valid JSON-encoded string."
    }
  ]
}

GET /fd-api/v1/dispatches

Get dispatches. Request will be paginated to 20 items by default.

GET /fd-api/v1/dispatches

Parameters

The Link header includes pagination information:

Link: <https://sizeup.firstduesizeup.com/fd-api/v1/dispatches?page=2>; rel="next",
  <https://sizeup.firstduesizeup.com/fd-api/v1/dispatches?page=7>; rel="last"

The possible rel values are:

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -G --data-urlencode "since=2019-02-15T19:00:00+00:00" https://sizeup.firstduesizeup.com/fd-api/v1/dispatches

Success Response

HTTP/1.1 200 OK
Link: <https://sizeup.firstduesizeup.com/fd-api/v1/dispatches?page=2>; rel="next",
  <https://sizeup.firstduesizeup.com/fd-api/v1/dispatches?page=7>; rel="last"

[
  {
    "id": 123,
    "type": "FD TYPE",
    "message": "FD MESSAGE",
    "place_name": "PLACE NAME",
    "address": "FD ADDRESS",
    "address2": "APT 123",
    "cross_streets": "CROSS STREET1 / CROSS STREET2",
    "city": "FD CITY",
    "state_code": "WA",
    "latitude": 47.633523,
    "longitude": -122.277157,
    "unit_codes": ["U1"],
    "incident_type_code": "118CR",
    "status_code": "open",
    "xref_id": "FD_ID1",
    "created_at": "2019-02-16T19:42:00+00:00",
    "radio_channel": "RADIO CHANNEL",
    "alarm_level": "01",
    "fire_zone": "abc fd",
    "fire_stations": [
        "Station 4",
        "Station 3"
    ],
  },
  {
    ...
  }
]

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": "Validation Failed. Please provide a valid since parameter.",
  "errors": [
    {
      "field": "since",
      "code": "invalid",
      "message": "Please provide a date in ISO 8601 format."
    }
  ]
}

GET /fd-api/v1/dispatches-responder-unit

Get active dispatch responder units for a client. This API provides active dispatch responder units (responder units) for the given client. Returns the latest responder status per user/device/dispatch combination, optionally filtered by status change time. Requires Bearer token and apiReadDispatch permission. The client is specified via the required client_code query parameter.

GET /fd-api/v1/dispatches-responder-unit

Parameters

The Link header includes pagination information:

Link Example 1: <https://sizeup.firstduesizeup.com/fd-api/v1/dispatches-responder-unit?client_code=CLIENT_CODE_1&page=2>; rel="next",
  <https://sizeup.firstduesizeup.com/fd-api/v1/dispatches-responder-unit?client_code=CLIENT_CODE_1&page=7>; rel="last"

Link Example 2: <https://sizeup.firstduesizeup.com/fd-api/v1/dispatches-responder-unit?client_code=CLIENT_CODE_1&page=2&since=2019-02-15T19%3A00%3A00%2B00%3A00&include_previous_status=true>; rel="next",
  <https://sizeup.firstduesizeup.com/fd-api/v1/dispatches-responder-unit?client_code=CLIENT_CODE_1&page=12&since=2019-02-15T19%3A00%3A00%2B00%3A00&include_previous_status=true>; rel="last"

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -G --data-urlencode "client_code=CLIENT_CODE_1" https://sizeup.firstduesizeup.com/fd-api/v1/dispatches-responder-unit

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -G --data-urlencode "client_code=CLIENT_CODE_1" --data-urlencode "since=2025-01-01T00:00:00+00:00" --data-urlencode "page=1" --data-urlencode "include_previous_status=true" https://sizeup.firstduesizeup.com/fd-api/v1/dispatches-responder-unit

Success Response

HTTP/1.1 200 OK
Link: <https://sizeup.firstduesizeup.com/fd-api/v1/dispatches-responder-unit?client_code=CLIENT_CODE_1&page=2>; rel="next",
  <https://sizeup.firstduesizeup.com/fd-api/v1/dispatches-responder-unit?client_code=CLIENT_CODE_1&page=7>; rel="last"

{
  "items": [
    {
      "name": "John Doe",
      "device_name": "iPhone",
      "eta": "300",
      "title": "Captain",
      "status": "to_scene",
      "station_num": "1",
      "since": "2025-02-08T14:30:00+00:00",
      "unit_code": "M31",
      "dispatch_id": "123",
      "dispatch_client_code": "CLIENT_CODE_1",
      "xref_id": "FD_ID1",
      "previous_status": "dispatched",
      "is_current_user": false
    }
  ],
  "total": 42,
  "page": 1,
  "page_size": 100
}

When include_previous_status=true, each item includes previous_status (see example above). When include_previous_status=false or omitted, previous_status is not present. Field reference:

Response is limited to 100 items per page (page_size). When the client has no dispatches or responder units, the endpoint returns 200 OK with an empty result set: items: [] and total: 0.

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 400 Bad Request
{
  "code": 0,
  "message": "Invalid since parameter. Use ISO 8601 datetime format."
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": "Validation Failed. Please provide client_code parameter.",
  "errors": [
    {
      "field": "client_code",
      "code": "missing_field",
      "message": "Please provide client_code parameter."
    }
  ]
}

POST /fd-api/v1/dispatches

Create a dispatch.

POST /fd-api/v1/dispatches

Parameters

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X POST -d '{"type": "TYPE", "message": "MESSAGE", "address": "ADDRESS", "address2": "APT 123", "city": "CITY", "state_code": "NY", "latitude": 40.0, "longitude": -120.0, "unit_codes": "U1,U2,U3", "incident_type_code": "118CR", "xref_id": "FD_ID1"}' https://sizeup.firstduesizeup.com/fd-api/v1/dispatches

Success Response

HTTP/1.1 204 No Content

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

HTTP/1.1 409 Conflict
{
  "code": 0,
  "message": "Object already exists."
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": "Validation Failed. Please provide address parameter.",
  "errors": [
    {
      "field": "address",
      "code": "missing_field",
      "message": "Please provide address parameter."
    }
  ]
}

PATCH /fd-api/v1/dispatches/xref/:xref_id

Update dispatch item.

PATCH /fd-api/v1/dispatches/xref/:xref_id

Parameters

Example Requests

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X PATCH -d '{"status_code": "closed"}' https://sizeup.firstduesizeup.com/fd-api/v1/dispatches/xref/FD_ID1

Success Response

HTTP/1.1 204 No Content

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "The requested item does not exist or access denied."
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": "State is of the wrong length (should be 2 characters)."
}

PUT /fd-api/v1/dispatches/xref/:xref_id

Update dispatch item completely.

PUT /fd-api/v1/dispatches/xref/:xref_id

Parameters

Example Requests

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X PUT -d '{"type": "TYPE", "message": "MESSAGE", "address": "ADDRESS", "address2": "APT 123", "city": "CITY", "state_code": "NY", "latitude": 40.0, "longitude": -120.0, "unit_codes": "U1,U2,U3", "incident_type_code": "118CR", "status_code": "closed"}' https://sizeup.firstduesizeup.com/fd-api/v1/dispatches/xref/FD_ID1

Success Response

HTTP/1.1 204 No Content

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "The requested item does not exist or access denied."
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": "Validation Failed. Please provide address parameter.",
  "errors": [
    {
      "field": "address",
      "code": "missing_field",
      "message": "Please provide address parameter."
    }
  ]
}

DELETE /fd-api/v1/dispatches/xref/:xref_id

Delete dispatch item.

DELETE /fd-api/v1/dispatches/xref/:xref_id

Parameters

Example Requests

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X DELETE https://sizeup.firstduesizeup.com/fd-api/v1/dispatches/xref/FD_ID1

Success Response

HTTP/1.1 204 No Content

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "The requested item does not exist or access denied."
}

GET /fd-api/v1/get-units-by-dispatches

Get units by dispatches. Request will be paginated to 20 items of dispatch and its related units by default.

GET /fd-api/v1/get-units-by-dispatches

Parameters

The Link header includes pagination information:

Link Example 1: <https://sizeup.firstduesizeup.com/fd-api/v1/get-units-by-dispatches?page=2>; rel="next",
  <https://sizeup.firstduesizeup.com/fd-api/v1/get-units-by-dispatches?page=7>; rel="last"

Link Example 2: <https://sizeup.firstduesizeup.com/fd-api/v1/get-units-by-dispatches?page=2&since=2019-02-15T19%3A00%3A00%2B00%3A00&active_only=true>; rel="next",
  <https://sizeup.firstduesizeup.com/fd-api/v1/get-units-by-dispatches?page=12&since=2019-02-15T19%3A00%3A00%2B00%3A00&active_only=true>; rel="last"

The possible rel values are:

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -G --data-urlencode "since=2024-09-01T19:00:00+00:00" https://sizeup.firstduesizeup.com/fd-api/v1/get-units-by-dispatches

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -G --data-urlencode "dispatch_id=3418" https://sizeup.firstduesizeup.com/fd-api/v1/get-units-by-dispatches

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -G ---data-urlencode "start=2024-09-01T08:00:00+00:00" --data-urlencode "active_only=true" https://sizeup.firstduesizeup.com/fd-api/v1/get-units-by-dispatches

Success Response

HTTP/1.1 200 OK
Link: <https://sizeup.firstduesizeup.com/fd-api/v1/get-units-by-dispatches?page=2>; rel="next",
  <https://sizeup.firstduesizeup.com/fd-api/v1/get-units-by-dispatches?page=7>; rel="last"

[
  {
    "id": 3418,
    "type": "Mobile Property (Vehicle) Fire Test type",
    "status_code": "open",
    "incident_type_code": null,
    "unit_codes": [
      "ZODI1",
      "BRSH1",
      "SQD3",
      "TRK5",
      "UTIL3"
    ],
    "created_at": "2024-09-24T08:42:35+00:00",
    "place_name": "PLACE NAME",
    "address": "FD ADDRESS",
    "address2": "APT 123",
    "city": "FD CITY",
    "state_code": "WA",
    "location": "FD ADDRESS, FD CITY, WA, 12345",
    "latitude": 47.633523,
    "longitude": -122.277157,
    "message": null,
    "call_notes": "This is the call notes of dispatch mobile property  hyd w3",
    "units": [
      {
        "id": 2,
        "name": "User #2 Name",
        "email": "u2@fdsu.tld",
        "statuses": [
          {
            "name": "Transport",
            "status_code": "transport",
            "created_at": "2024-09-24T09:27:10+00:00"
          },
          {
            "name": "To Station",
            "status_code": "to_station",
            "created_at": "2024-09-24T09:26:35+00:00"
          },
          {
            "name": "On Scene",
            "status_code": "on_scene",
            "created_at": "2024-09-24T09:20:10+00:00"
          },
          {
            "name": "To Station",
            "status_code": "to_station",
            "created_at": "2024-09-24T09:19:50+00:00"
          }
        ]
      },
      {
        "id": 39605,
        "name": "User 39605 Name",
        "email": "user39605@fdsu.tld",
        "statuses": [
          {
              "name": "On Station",
              "status_code": "on_station",
              "created_at": "2024-09-24T10:01:00+00:00"
          },
          {
              "name": "In Service",
              "status_code": "in_service",
              "created_at": "2024-09-24T09:18:57+00:00"
          },
          {
              "name": "On Scene",
              "status_code": "on_scene",
              "created_at": "2024-09-24T09:18:55+00:00"
          },
          {
              "name": "On Station",
              "status_code": "on_station",
              "created_at": "2024-09-24T09:18:24+00:00"
          }
        ]
      }
    ],
    "xref_id": "ABC-123"
  },
  {
      "id": 3415,
      "type": "Police/DPS Assistance",
      "status_code": "open",
      "incident_type_code": null,
      "unit_codes": [],
      "created_at": "2024-09-20T09:36:59+00:00",
      "place_name": null,
      "address": "Robert Street",
      "address2": null,
      "city": "Laredo",
      "state_code": null,
      "location": "ROBERT STREET, LAREDO, TX, 78046",
      "latitude": 33.1134323,
      "longitude": -96.111101,
      "message": null,
      "call_notes": "This is call notes for record",
      "units": [],
      "xref_id": "DEF-456"
  },
  {
    ...
  }
]

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": "Validation Failed. Please provide a valid since parameter.",
  "errors": [
    {
      "field": "since",
      "code": "invalid",
      "message": "Please provide a date in ISO 8601 format."
    }
  ]
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": "Validation Failed. Please provide valid dispatch_id parameter.",
  "errors": [
      {
        "field": "dispatch_id",
        "code": "invalid",
        "message": "Please provide a valid integer."
      }
  ]
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": "Validation Failed. Please provide valid since, active_only parameters.",
  "errors": [
      {
        "field": "since",
        "code": "invalid",
        "message": "Please provide a date in ISO 8601 format."
      },
      {
        "field": "active_only",
        "code": "invalid",
        "message": "Please provide a valid boolean value true or false."
      }
  ]
}

HEAD /fd-api/v1/iams/email/:email

Check that IAMS authentication is enabled for the email.

HEAD /fd-api/v1/iams/email/:email

Parameters

Example Request

$ curl -i -k -I -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" https://sizeup.firstduesizeup.com/fd-api/v1/iams/email/test@test.com

Success Response

HTTP/1.1 200 OK

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "The requested item does not exist or access denied."
}

GET /fd-api/v1/tce-premises/xref/:premise_id

Get a TCE premise.

GET /fd-api/v1/tce-premises/xref/:premise_id

Parameters

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" https://sizeup.firstduesizeup.com/fd-api/v1/tce-premises/xref/111

Success Response

HTTP/1.1 200 OK
{
  "name": "The vault",
  "address1": "ADDRESS",
  "address2": "APT 25",
  "city": "CITY",
  "state_code": "WA",
  "zip": "12345",
  "latitude": 40,
  "longitude": -120,
  "status_code": "INACTIVE",
  "tag_color_code": null
}

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

POST /fd-api/v1/tce-premises

Create a TCE premise.

POST /fd-api/v1/tce-premises

Parameters

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X POST -d '{"premise_id": 111, "name": "The vault", "address1": "ADDRESS", "address2": "APT 25", "city": "CITY", "state_code": "WA", "zip": "12345", "latitude": 40.0, "longitude": -120.0, "status_code": "ACTIVE"}' https://sizeup.firstduesizeup.com/fd-api/v1/tce-premises

Success Response

HTTP/1.1 204 No Content

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

HTTP/1.1 409 Conflict
{
  "code": 0,
  "message": "Object already exists."
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": "Validation Failed. Please provide address parameter.",
  "errors": [
    {
      "field": "address",
      "code": "missing_field",
      "message": "Please provide address parameter."
    }
  ]
}

PATCH /fd-api/v1/tce-premises/xref/:premise_id

Update a TCE premise.

PATCH /fd-api/v1/tce-premises/xref/:premise_id

Parameters

Example Requests

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X PATCH -d '{"status_code": "INACTIVE"}' https://sizeup.firstduesizeup.com/fd-api/v1/tce-premises/xref/111

Success Response

HTTP/1.1 204 No Content

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "The requested item does not exist or access denied."
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": "State is of the wrong length (should be 2 characters)."
}

GET /fd-api/v1/tce-systems/xref/:system_id

Get a TCE system.

GET /fd-api/v1/tce-systems/xref/:system_id

Parameters

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" https://sizeup.firstduesizeup.com/fd-api/v1/tce-systems/xref/222

Success Response

HTTP/1.1 200 OK
{
  "premise_id": 111,
  "system_type_name": "Standpipe",
  "last_inspection_date": "2019-09-08",
  "next_inspection_date": "2020-09-10",
  "has_open_deficiencies": true,
  "status_code": "ACTIVE",
  "tag_color_code": "RED",
  "is_current": true,
  "is_inventory_tracked": false,
  "max_inventory_count": null,
  "is_service_dates_based_on_inventory": false
}

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

POST /fd-api/v1/tce-systems

Create a TCE system.

POST /fd-api/v1/tce-systems

Parameters

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X POST -d '{"system_id": 222, "premise_id": 111, "system_type_name": "Standpipe", "last_inspection_date": "2019-09-08", "next_inspection_date": "2020-09-09", "has_open_deficiencies": true, "status_code": "ACTIVE", "is_inventory_tracked": false, "max_inventory_count": 0, "is_service_dates_based_on_inventory": false}' https://sizeup.firstduesizeup.com/fd-api/v1/tce-systems

Success Response

HTTP/1.1 204 No Content

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

HTTP/1.1 409 Conflict
{
  "code": 0,
  "message": "Object already exists."
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": "Validation Failed. Please provide system_id parameter."
}

PATCH /fd-api/v1/tce-systems/xref/:system_id

Update a TCE system.

PATCH /fd-api/v1/tce-systems/xref/:system_id

Parameters

Example Requests

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X PATCH -d '{"next_inspection_date": "2020-09-10"}' https://sizeup.firstduesizeup.com/fd-api/v1/tce-systems/xref/222

Success Response

HTTP/1.1 204 No Content

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "The requested item does not exist or access denied."
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": "Please enter valid next inspection date."
}

GET /fd-api/v1/tce-inventories/xref/:inventory_id

Get a TCE inventory.

GET /fd-api/v1/tce-inventories/xref/:inventory_id

Parameters

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" https://sizeup.firstduesizeup.com/fd-api/v1/tce-inventories/xref/333

Success Response

HTTP/1.1 200 OK
{
  "premise_id": 111,
  "system_id": 222,
  "system_type_name": "Elevator",
  "last_inspection_date": null,
  "next_inspection_date": "2020-09-07",
  "has_open_deficiencies": false,
  "description": "SW Tower Car 2",
  "status_code": "INACTIVE",
  "tag_color_code": "YELLOW",
  "is_current": false
}

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

POST /fd-api/v1/tce-inventories

Create a TCE inventory.

POST /fd-api/v1/tce-inventories

Parameters

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X POST -d '{"inventory_id": 333, "premise_id": 111, "system_id": 222, "system_type_name": "Elevator", "next_inspection_date": "2020-09-07", "has_open_deficiencies": false, "description": "SW Tower Car 2", "status_code": "ACTIVE", "tag_color_code": "RED"}' https://sizeup.firstduesizeup.com/fd-api/v1/tce-inventories

Success Response

HTTP/1.1 204 No Content

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

HTTP/1.1 409 Conflict
{
  "code": 0,
  "message": "Object already exists."
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": "Validation Failed. Please provide system_id parameter."
}

PATCH /fd-api/v1/tce-inventories/xref/:inventory_id

Update a TCE inventory.

PATCH /fd-api/v1/tce-inventories/xref/:inventory_id

Parameters

Example Requests

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X PATCH -d '{"has_open_deficiencies": false, "status_code": "INACTIVE", "tag_color_code": "YELLOW"}' https://sizeup.firstduesizeup.com/fd-api/v1/tce-inventories/xref/333

Success Response

HTTP/1.1 204 No Content

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "The requested item does not exist or access denied."
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": "Please enter valid status code."
}

GET /fd-api/v1/preplans/units/caution-notes

Get list of Caution Notes.

GET /fd-api/v1/preplans/units/caution-notes

Parameters

The Link header includes pagination information:

Link: <https://sizeup.firstduesizeup.com/fd-api/v1/preplans/units/caution-notes?page=2>; rel="next",
  <https://sizeup.firstduesizeup.com/fd-api/v1/preplans/units/caution-notes?page=7>; rel="last"

The possible rel values are:

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -G --data-urlencode "page=2" https://sizeup.firstduesizeup.com/fd-api/v1/preplans/units/caution-notes

Success Response

HTTP/1.1 200 OK
Link: <https://sizeup.firstduesizeup.com/fd-api/v1/preplans/units/caution-notes?page=3>; rel="next",
  <https://sizeup.firstduesizeup.com/fd-api/v1/preplans/units/caution-notes?page=7>; rel="last"

[
  {
    "xref_id": "123"
  },
  {
    "xref_id": "456"
  }
]

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

POST /fd-api/v1/preplans/units/caution-notes

Import a bunch of caution notes as preplan units. This will create or update every single record. The response objects are returned in the order in which the caution notes were specified.

POST /fd-api/v1/preplans/units/caution-notes

Parameters is an array of objects. Max size is 1000 items.

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X POST -d '[{"xref_id": 1, "address": "123 ADDRESS", "apt": "33A", "city": "CITY", "state_code": "NY", "notes": "CAUTION NOTES", "category_code": "INFO", "from_date": "2019-02-16", "to_date": "2029-02-16"}]' https://sizeup.firstduesizeup.com/fd-api/v1/preplans/units/caution-notes

Success Response

HTTP/1.1 200 OK
[
  {
    "success": true,
    "errors": []
  },
  {
    "success": false,
    "errors": ["Please provide address parameter."]
  }
]

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": "Validation Failed. Max items allowed exceeded.",
  "errors": []
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": Validation Failed. Empty parameters.",
  "errors": []
}

DELETE /fd-api/v1/preplans/units/caution-notes

Delete a bunch of Caution Notes by Xref ID

DELETE /fd-api/v1/preplans/units/caution-notes

Parameters

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X DELETE https://sizeup.firstduesizeup.com/fd-api/v1/preplans/units/caution-notes?xref_ids=1,2,3

Success Response

HTTP/1.1 200 OK
[
  {
    "xref_id": "1",
    "success": true,
    "errors": []
  },
  {
    "xref_id": "222",
    "success": false,
    "errors": ["Please provide valid Xref Id."]
  }
]

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": "Validation Failed. Max items allowed exceeded.",
  "errors": []
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": Validation Failed. Empty parameters.",
  "errors": []
}

GET /fd-api/v1/nfirs-notifications/:id

Get a NFIRS notification.

GET /fd-api/v1/nfirs-notifications/:id

Parameters

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" https://sizeup.firstduesizeup.com/fd-api/v1/nfirs-notifications/111

Success Response

HTTP/1.1 200 OK
{
  "id": 111,
  "dispatch_number": "DN-01",
  "incident_number": "2021-00001",
  "dispatch_type": "DISPATCH_TYPE",
  "dispatch_incident_type_code": "118CR",
  "alarm_at": "2019-02-16T19:42:00+00:004",
  "dispatch_notified_at": "2019-02-16T19:42:00+00:004",
  "alarms": 3,
  "place_name": "PLACE_NAME",
  "business_name": "BUSINESS_NAME",
  "location_info": "LOCATION_INFO",
  "venue": "VENUE",
  "address": "ADDRESS",
  "unit": "APT 123",
  "cross_streets": "CROSS_STREETS",
  "city": "CITY",
  "state_code": "NY",
  "zip_code": "11111",
  "latitude": 40.0,
  "longitude": -120.0,
  "narratives": "NARRATIVES",
  "shift_name": "SHIFT_NAME",
  "notification_type": "NOTIFICATION_TYPE",
  "aid_type_code": 1,
  "aid_fdid_number": "12345",
  "aid_fdid_numbers": ["12345", "67890"],
  "aid_direction": "01",
  "aid_department_entity_ids": ["FD14852327","FD12323225"],
  "nonfd_aids": ["01", "02"],
  "controlled_at": "2019-02-16T19:42:00+00:004",
  "officer_in_charge": "oic-123456789",
  "call_completed_at": "2019-02-16T19:42:00+00:004",
  "zone": "Zone Name",
  "ems_incident_number": "2021",
  "ems_response_number": "00001",
  "station": "09",
  "emd_card_number": "10C01",
  "psap_call_answered_at": "2019-02-16T19:42:00+00:004",
  "call_transferred_at": "2019-02-16T19:42:00+00:004",
  "psap_call_at": "2019-02-16T19:42:00+00:004",
  "command_established_at": "2025-08-29T06:52:28+00:00",
  "incident_end_at": "2025-08-30T16:12:12+00:00",
  "agent_applied_at": "2025-12-15T16:12:12+00:00"
}

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

GET /fd-api/v1/nfirs-notifications/number/:incident_number

Get a NFIRS notification.

GET /fd-api/v1/nfirs-notifications/number/:incident_number

Parameters

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" https://sizeup.firstduesizeup.com/fd-api/v1/nfirs-notifications/number/111

Success Response

HTTP/1.1 200 OK
{
  "id": 111,
  "dispatch_number": "DN-01",
  "incident_number": "2021-00001",
  "dispatch_type": "DISPATCH_TYPE",
  "dispatch_incident_type_code": "118CR",
  "alarm_at": "2019-02-16T19:42:00+00:004",
  "dispatch_notified_at": "2019-02-16T19:42:00+00:004",
  "alarms": 3,
  "place_name": "PLACE_NAME",
  "business_name": "BUSINESS_NAME",
  "location_info": "LOCATION_INFO",
  "venue": "VENUE",
  "address": "ADDRESS",
  "unit": "APT 123",
  "cross_streets": "CROSS_STREETS",
  "city": "CITY",
  "state_code": "NY",
  "zip_code": "11111",
  "latitude": 40.0,
  "longitude": -120.0,
  "narratives": "NARRATIVES",
  "shift_name": "SHIFT_NAME",
  "notification_type": "NOTIFICATION_TYPE",
  "aid_type_code": 1,
  "aid_fdid_number": "12345",
  "aid_fdid_numbers": ["12345", "67890"],
  "aid_direction": "01",
  "aid_department_entity_ids": ["FD14852327","FD12323225"],
  "nonfd_aids": ["01", "02"],
  "controlled_at": "2019-02-16T19:42:00+00:004",
  "officer_in_charge": "oic-123456789",
  "call_completed_at": "2019-02-16T19:42:00+00:004",
  "zone": "Zone Name",
  "ems_incident_number": "2021",
  "ems_response_number": "00001",
  "station": "09",
  "emd_card_number": "10C01",
  "psap_call_answered_at": "2019-02-16T19:42:00+00:004",
  "call_transferred_at": "2019-02-16T19:42:00+00:004",
  "psap_call_at": "2019-02-16T19:42:00+00:004",
  "command_established_at": "2025-08-29T06:52:28+00:00",
  "incident_end_at": "2025-08-30T16:12:12+00:00",
  "agent_applied_at": "2025-12-15T16:12:12+00:00"
}

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

GET /fd-api/v1/nfirs-notifications/dispatch-number/:dispatch_number

Get a NFIRS notification.

GET /fd-api/v1/nfirs-notifications/dispatch-number/:dispatch_number

Parameters

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" https://sizeup.firstduesizeup.com/fd-api/v1/nfirs-notifications/dispatch-number/111

Success Response

HTTP/1.1 200 OK
{
  "id": 111,
  "dispatch_number": "DN-01",
  "incident_number": "2021-00001",
  "dispatch_type": "DISPATCH_TYPE",
  "dispatch_incident_type_code": "118CR",
  "alarm_at": "2019-02-16T19:42:00+00:004",
  "dispatch_notified_at": "2019-02-16T19:42:00+00:004",
  "alarms": 3,
  "place_name": "PLACE_NAME",
  "business_name": "BUSINESS_NAME",
  "location_info": "LOCATION_INFO",
  "venue": "VENUE",
  "address": "ADDRESS",
  "unit": "APT 123",
  "cross_streets": "CROSS_STREETS",
  "city": "CITY",
  "state_code": "NY",
  "zip_code": "11111",
  "latitude": 40.0,
  "longitude": -120.0,
  "narratives": "NARRATIVES",
  "shift_name": "SHIFT_NAME",
  "notification_type": "NOTIFICATION_TYPE",
  "aid_type_code": 1,
  "aid_fdid_number": "12345",
  "aid_fdid_numbers": ["12345", "67890"],
  "aid_direction": "01",
  "aid_department_entity_ids": ["FD14852327","FD12323225"],
  "nonfd_aids": ["01", "02"],
  "controlled_at": "2019-02-16T19:42:00+00:004",
  "officer_in_charge": "oic-123456789",
  "call_completed_at": "2019-02-16T19:42:00+00:004",
  "zone": "Zone Name",
  "ems_incident_number": "2021",
  "ems_response_number": "00001",
  "station": "09",
  "emd_card_number": "10C01",
  "psap_call_answered_at": "2019-02-16T19:42:00+00:004",
  "call_transferred_at": "2019-02-16T19:42:00+00:004",
  "psap_call_at": "2019-02-16T19:42:00+00:004",
  "command_established_at": "2025-08-29T06:52:28+00:00",
  "incident_end_at": "2025-08-30T16:12:12+00:00",
  "agent_applied_at": "2025-12-15T16:12:12+00:00"
}

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

POST /fd-api/v1/nfirs-notifications

Create a NFIRS notification.

POST /fd-api/v1/nfirs-notifications

Parameters

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X POST -d '{"dispatch_number": "DN-01", "incident_number": "2021-00001", "dispatch_type": "DISPATCH_TYPE", "dispatch_incident_type_code": "118CR", "alarm_at": "2019-02-16T19:42:00+00:004", "dispatch_notified_at": "2019-02-16T19:42:00+00:004", "alarms": 3, "place_name": "PLACE_NAME", "business_name": "BUSINESS_NAME", "location_info": "LOCATION_INFO", "venue": "VENUE", "address": "ADDRESS", "unit": "APT 123", "cross_streets": "CROSS_STREETS", "city": "CITY", "state_code": "NY", "latitude": 40.0, "longitude": -120.0, "narratives": "NARRATIVES", "shift_name": "SHIFT_NAME", "notification_type": "NOTIFICATION_TYPE",  "aid_type_code": 1, "aid_fdid_number": "12345", "aid_fdid_numbers": ["12345", "67890"], "controlled_at": "2019-02-16T19:42:00+00:004", "zone": "Zone Name", "psap_call_answered_at": "2025-05-15T14:30:55+00:00", "call_transferred_at": "2025-05-15T14:30:55+00:00", "psap_call_at": "2019-02-16T19:42:00+00:004", "command_established_at": "2025-05-15T14:30:55+00:00", "cad_priority": "High", "incident_end_at": "2025-08-15T19:42:00+00:00", "agent_applied_at": "2025-12-15T16:30:55+00:00", "aid_direction": "01", "aid_department_entity_ids": ["FD14852327","FD12323225"],"nonfd_aids": ["01", "02"]}' https://sizeup.firstduesizeup.com/fd-api/v1/nfirs-notifications

Success Response

HTTP/1.1 201 Created
{
  "id": 111
}

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

HTTP/1.1 409 Conflict
{
  "code": 0,
  "message": "Object already exists."
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": "Validation Failed. Please provide address parameter.",
  "errors": [
    {
      "field": "address",
      "code": "missing_field",
      "message": "Please provide address parameter."
    }
  ]
}

PUT /fd-api/v1/nfirs-notifications/:id

Update NFIRS notification item completely.

PUT /fd-api/v1/nfirs-notifications/:id

Parameters

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X PUT -d '{"dispatch_number": "DN-01", "incident_number": "2021-00001", "dispatch_type": "DISPATCH_TYPE", "dispatch_incident_type_code": "118CR", "alarm_at": "2019-02-16T19:42:00+00:004", "dispatch_notified_at": "2019-02-16T19:42:00+00:004", "alarms": 3, "place_name": "PLACE_NAME", "business_name": "BUSINESS_NAME", "location_info": "LOCATION_INFO", "venue": "VENUE", "address": "ADDRESS", "unit": "APT 123", "cross_streets": "CROSS_STREETS", "city": "CITY", "state_code": "NY", "latitude": 40.0, "longitude": -120.0, "narratives": "NARRATIVES", "shift_name": "SHIFT_NAME", "notification_type": "NOTIFICATION_TYPE", "aid_type_code": 1, "aid_fdid_number": "12345", "aid_fdid_numbers": "["12345", "67890"]", "controlled_at": "2019-02-16T19:42:00+00:004", "zone": "Zone Name", "command_established_at": "2025-08-29T06:52:28+00:00", "cad_priority": "High", "incident_end_at": "2025-08-30T19:48:12+00:00", "agent_applied_at": "2025-12-15T16:48:12+00:00", "aid_direction": "01", "aid_department_entity_ids": ["FD14852327","FD12323225"],"nonfd_aids": ["01", "02"]}' https://sizeup.firstduesizeup.com/fd-api/v1/nfirs-notifications/24

Success Response

HTTP/1.1 204 No Content

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "The requested item does not exist or access denied."
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": "Validation Failed. Please provide address parameter.",
  "errors": [
    {
      "field": "address",
      "code": "missing_field",
      "message": "Please provide address parameter."
    }
  ]
}

PUT /fd-api/v1/nfirs-notifications/number/:incident_number

Update NFIRS notification item completely.

PUT /fd-api/v1/nfirs-notifications/number/:incident_number

Parameters

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X PUT -d '{"dispatch_number": "DN-01", "dispatch_type": "DISPATCH_TYPE", "dispatch_incident_type_code": "118CR", "alarm_at": "2019-02-16T19:42:00+00:004", "dispatch_notified_at": "2019-02-16T19:42:00+00:004", "alarms": 3, "place_name": "PLACE_NAME", "business_name": "BUSINESS_NAME", "location_info": "LOCATION_INFO", "venue": "VENUE", "address": "ADDRESS", "unit": "APT 123", "cross_streets": "CROSS_STREETS", "city": "CITY", "state_code": "NY", "latitude": 40.0, "longitude": -120.0, "narratives": "NARRATIVES", "shift_name": "SHIFT_NAME", "notification_type": "NOTIFICATION_TYPE", "aid_type_code": 1, "aid_fdid_number": "12345", "aid_fdid_numbers": ["12345", "67890"], "controlled_at": "2019-02-16T19:42:00+00:004", "zone": "Zone", "command_established_at": "2025-08-29T06:52:28+00:00", "cad_priority": "High", "incident_end_at": "2025-08-30T19:48:12+00:00", "agent_applied_at": "2025-12-15T16:30:55+00:00", "aid_direction": "01", "aid_department_entity_ids": ["FD14852327","FD12323225"], "nonfd_aids": ["01", "02"]}' https://sizeup.firstduesizeup.com/fd-api/v1/nfirs-notifications/number/2021-00001

Success Response

HTTP/1.1 204 No Content

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "The requested item does not exist or access denied."
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": "Validation Failed. Please provide address parameter.",
  "errors": [
    {
      "field": "address",
      "code": "missing_field",
      "message": "Please provide address parameter."
    }
  ]
}

PUT /fd-api/v1/nfirs-notifications/dispatch-number/:dispatch_number

Update NFIRS notification item completely.

PUT /fd-api/v1/nfirs-notifications/dispatch-number/:dispatch_number

Parameters

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X PUT -d '{"incident_number": "DN-01", "dispatch_type": "DISPATCH_TYPE", "dispatch_incident_type_code": "118CR", "alarm_at": "2019-02-16T19:42:00+00:004", "dispatch_notified_at": "2019-02-16T19:42:00+00:004", "alarms": 3, "place_name": "PLACE_NAME", "business_name": "BUSINESS_NAME", "location_info": "LOCATION_INFO", "venue": "VENUE", "address": "ADDRESS", "unit": "APT 123", "cross_streets": "CROSS_STREETS", "city": "CITY", "state_code": "NY", "latitude": 40.0, "longitude": -120.0, "narratives": "NARRATIVES", "shift_name": "SHIFT_NAME", "notification_type": "NOTIFICATION_TYPE", "aid_type_code": 1, "aid_fdid_number": "12345", "aid_fdid_numbers": ["12345", "67890"], "controlled_at": "2019-02-16T19:42:00+00:004", "zone": "Zone", "command_established_at": "2025-08-29T06:52:28+00:00", "cad_priority": "High", "incident_end_at": "2025-08-30T19:48:12+00:00", "agent_applied_at": "2025-12-15T16:30:55+00:00", "aid_direction": "01", "aid_department_entity_ids": ["FD14852327","FD12323225"],"nonfd_aids": ["01", "02"]}' https://sizeup.firstduesizeup.com/fd-api/v1/nfirs-notifications/dispatch-number/2021-00001

Success Response

HTTP/1.1 204 No Content

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "The requested item does not exist or access denied."
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": "Validation Failed. Please provide address parameter.",
  "errors": [
    {
      "field": "address",
      "code": "missing_field",
      "message": "Please provide address parameter."
    }
  ]
}

DELETE /fd-api/v1/nfirs-notifications/:id

Delete NFIRS notification item.

DELETE /fd-api/v1/nfirs-notifications/:id

Parameters

Example Requests

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X DELETE https://sizeup.firstduesizeup.com/fd-api/v1/nfirs-notifications/24

Success Response

HTTP/1.1 204 No Content

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "The requested item does not exist or access denied."
}

DELETE /fd-api/v1/nfirs-notifications/number/:incident_number

Delete NFIRS notification item.

DELETE /fd-api/v1/nfirs-notifications/number/:incident_number

Parameters

Example Requests

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X DELETE https://sizeup.firstduesizeup.com/fd-api/v1/nfirs-notifications/number/2021-00001

Success Response

HTTP/1.1 204 No Content

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "The requested item does not exist or access denied."
}

DELETE /fd-api/v1/nfirs-notifications/dispatch-number/:dispatch_number

Delete NFIRS notification item.

DELETE /fd-api/v1/nfirs-notifications/dispatch-number/:dispatch_number

Parameters

Example Requests

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X DELETE https://sizeup.firstduesizeup.com/fd-api/v1/nfirs-notifications/dispatch-number/2021-00001

Success Response

HTTP/1.1 204 No Content

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "The requested item does not exist or access denied."
}

POST /fd-api/v1/nfirs-notifications/:nfirs_notification_id/apparatuses

Create a NFIRS notification apparatus.

POST /fd-api/v1/nfirs-notifications/:nfirs_notification_id/apparatuses

Parameters

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X POST -d '{"unit_code": "R2", "is_aid": false, "dispatch_at": "2019-02-16T19:42:00+00:004", "arrive_at": "2019-02-16T19:42:00+00:004", "dispatch_acknowledged_at": "2019-02-16T19:42:00+00:004", "enroute_at": "2019-02-16T19:42:00+00:004", "clear_at": "2019-02-16T19:42:00+00:004", "back_in_service_at": "2019-02-16T19:42:00+00:004", "canceled_at": "2019-02-16T19:42:00+00:004", "patient_arrived_at": "2019-02-16T19:42:00+00:004", "patient_transferred_at": "2019-02-16T19:42:00+00:004", "canceled_stage_code": "on_scene", "response_mode": 4, "latitude": 32.9515907, "longitude": -96.82060}' https://sizeup.firstduesizeup.com/fd-api/v1/nfirs-notifications/24/apparatuses
$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X POST -d '{"unit_code": "R2", "is_aid": false, "dispatch_at": "2019-02-16T19:42:00+00:004", "arrive_at": "2019-02-16T19:42:00+00:004", "dispatch_acknowledged_at": "2019-02-16T19:42:00+00:004", "enroute_at": "2019-02-16T19:42:00+00:004", "clear_at": "2019-02-16T19:42:00+00:004", "back_in_service_at": "2019-02-16T19:42:00+00:004", "canceled_at": "2019-02-16T19:42:00+00:004", "patient_arrived_at": "2019-02-16T19:42:00+00:004", "patient_transferred_at": "2019-02-16T19:42:00+00:004", "canceled_stage_code": "on_scene", "response_mode": 4, "notes": "This is a narrative"}' https://sizeup.firstduesizeup.com/fd-api/v1/nfirs-notifications/24/apparatuses

Success Response

HTTP/1.1 201 Created
{
  "id": 222
}

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

HTTP/1.1 409 Conflict
{
  "code": 0,
  "message": "Object already exists."
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": "Validation Failed. Please provide unit_code parameter.",
  "errors": [
    {
      "field": "unit_code",
      "code": "missing_field",
      "message": "Please provide unit_code parameter."
    }
  ]
}

POST /fd-api/v1/nfirs-notifications/number/:incident_number/apparatuses

Create a NFIRS notification apparatus.

POST /fd-api/v1/nfirs-notifications/number/:incident_number/apparatuses

Parameters

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X POST -d '{"unit_code": "R2", "is_aid": false, "dispatch_at": "2019-02-16T19:42:00+00:004", "arrive_at": "2019-02-16T19:42:00+00:004", "dispatch_acknowledged_at": "2019-02-16T19:42:00+00:004", "enroute_at": "2019-02-16T19:42:00+00:004", "clear_at": "2019-02-16T19:42:00+00:004", "back_in_service_at": "2019-02-16T19:42:00+00:004", "canceled_at": "2019-02-16T19:42:00+00:004", "patient_arrived_at": "2019-02-16T19:42:00+00:004", "patient_transferred_at": "2019-02-16T19:42:00+00:004", "canceled_stage_code": "on_scene", "response_mode": 4, "latitude": 32.9515907, "longitude": -96.82060}' https://sizeup.firstduesizeup.com/fd-api/v1/nfirs-notifications/number/2021-00001/apparatuses
$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X POST -d '{"unit_code": "R2", "is_aid": false, "dispatch_at": "2019-02-16T19:42:00+00:004", "arrive_at": "2019-02-16T19:42:00+00:004", "dispatch_acknowledged_at": "2019-02-16T19:42:00+00:004", "enroute_at": "2019-02-16T19:42:00+00:004", "clear_at": "2019-02-16T19:42:00+00:004", "back_in_service_at": "2019-02-16T19:42:00+00:004", "canceled_at": "2019-02-16T19:42:00+00:004", "patient_arrived_at": "2019-02-16T19:42:00+00:004", "patient_transferred_at": "2019-02-16T19:42:00+00:004", "canceled_stage_code": "on_scene", "response_mode": 4, "notes": "This is a narrative"}' https://sizeup.firstduesizeup.com/fd-api/v1/nfirs-notifications/number/2021-00001/apparatuses

Success Response

HTTP/1.1 204 No Content

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

HTTP/1.1 409 Conflict
{
  "code": 0,
  "message": "Object already exists."
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": "Validation Failed. Please provide unit_code parameter.",
  "errors": [
    {
      "field": "unit_code",
      "code": "missing_field",
      "message": "Please provide unit_code parameter."
    }
  ]
}

POST /fd-api/v1/nfirs-notifications/dispatch-number/:dispatch_number/apparatuses

Create a NFIRS notification apparatus.

POST /fd-api/v1/nfirs-notifications/dispatch-number/:dispatch_number/apparatuses

Parameters

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X POST -d '{"unit_code": "R2", "is_aid": false, "dispatch_at": "2019-02-16T19:42:00+00:004", "arrive_at": "2019-02-16T19:42:00+00:004", "dispatch_acknowledged_at": "2019-02-16T19:42:00+00:004", "enroute_at": "2019-02-16T19:42:00+00:004", "clear_at": "2019-02-16T19:42:00+00:004", "back_in_service_at": "2019-02-16T19:42:00+00:004", "canceled_at": "2019-02-16T19:42:00+00:004", "patient_arrived_at": "2019-02-16T19:42:00+00:004", "patient_transferred_at": "2019-02-16T19:42:00+00:004", "canceled_stage_code": "on_scene", "response_mode": 4, "latitude": 32.9515907, "longitude": -96.82060}' https://sizeup.firstduesizeup.com/fd-api/v1/nfirs-notifications/dispatch-number/2021-00001/apparatuses
$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X POST -d '{"unit_code": "R2", "is_aid": false, "dispatch_at": "2019-02-16T19:42:00+00:004", "arrive_at": "2019-02-16T19:42:00+00:004", "dispatch_acknowledged_at": "2019-02-16T19:42:00+00:004", "enroute_at": "2019-02-16T19:42:00+00:004", "clear_at": "2019-02-16T19:42:00+00:004", "back_in_service_at": "2019-02-16T19:42:00+00:004", "canceled_at": "2019-02-16T19:42:00+00:004", "patient_arrived_at": "2019-02-16T19:42:00+00:004", "patient_transferred_at": "2019-02-16T19:42:00+00:004", "canceled_stage_code": "on_scene", "response_mode": 4, "notes": "This is a narrative"}' https://sizeup.firstduesizeup.com/fd-api/v1/nfirs-notifications/dispatch-number/2021-00001/apparatuses

Success Response

HTTP/1.1 204 No Content

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

HTTP/1.1 409 Conflict
{
  "code": 0,
  "message": "Object already exists."
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": "Validation Failed. Please provide unit_code parameter.",
  "errors": [
    {
      "field": "unit_code",
      "code": "missing_field",
      "message": "Please provide unit_code parameter."
    }
  ]
}

PUT /fd-api/v1/nfirs-notifications/:nfirs_notification_id/apparatuses/:id

Update NFIRS notification apparatus item completely.

PUT /fd-api/v1/nfirs-notifications/:nfirs_notification_id/apparatuses/:id

Parameters

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X PUT -d '{"unit_code": "R2", "is_aid": false, "dispatch_at": '2019-02-16T19:42:00+00:004', "arrive_at": "2019-02-16T19:42:00+00:004", "dispatch_acknowledged_at": "2019-02-16T19:42:00+00:004", "enroute_at": "2019-02-16T19:42:00+00:004", "clear_at": "2019-02-16T19:42:00+00:004", "back_in_service_at": "2019-02-16T19:42:00+00:004", "canceled_at": "2019-02-16T19:42:00+00:004", "patient_arrived_at": "2019-02-16T19:42:00+00:004", "patient_transferred_at": "2019-02-16T19:42:00+00:004", "canceled_stage_code": "on_scene", "response_mode": 4, "latitude": 32.9515907, "longitude": -96.82060}' https://sizeup.firstduesizeup.com/fd-api/v1/nfirs-notifications/24/apparatuses/25
$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X PUT -d '{"unit_code": "R2", "is_aid": false, "dispatch_at": '2019-02-16T19:42:00+00:004', "arrive_at": "2019-02-16T19:42:00+00:004", "dispatch_acknowledged_at": "2019-02-16T19:42:00+00:004", "enroute_at": "2019-02-16T19:42:00+00:004", "clear_at": "2019-02-16T19:42:00+00:004", "back_in_service_at": "2019-02-16T19:42:00+00:004", "canceled_at": "2019-02-16T19:42:00+00:004", "patient_arrived_at": "2019-02-16T19:42:00+00:004", "patient_transferred_at": "2019-02-16T19:42:00+00:004", "canceled_stage_code": "on_scene", "response_mode": 4, "notes": "This is a narrative"}' https://sizeup.firstduesizeup.com/fd-api/v1/nfirs-notifications/24/apparatuses/25

Success Response

HTTP/1.1 204 No Content

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "The requested item does not exist or access denied."
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": "Validation Failed. Please provide unit_code parameter.",
  "errors": [
    {
      "field": "unit_code",
      "code": "missing_field",
      "message": "Please provide unit_code parameter."
    }
  ]
}

PUT /fd-api/v1/nfirs-notifications/number/:incident_number/apparatuses/code/:unit_code

Update NFIRS notification apparatus item completely.

PUT /fd-api/v1/nfirs-notifications/number/:incident_number/apparatuses/code/:unit_code

Parameters

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X PUT -d '{"is_aid": false, "dispatch_at": "2019-02-16T19:42:00+00:004", "arrive_at": "2019-02-16T19:42:00+00:004", "dispatch_acknowledged_at": "2019-02-16T19:42:00+00:004", "enroute_at": "2019-02-16T19:42:00+00:004", "clear_at": "2019-02-16T19:42:00+00:004", "back_in_service_at": "2019-02-16T19:42:00+00:004", "canceled_at": "2019-02-16T19:42:00+00:004", "patient_arrived_at": "2019-02-16T19:42:00+00:004", "patient_transferred_at": "2019-02-16T19:42:00+00:004", "canceled_stage_code": "on_scene", "response_mode": 4, "latitude": 32.9515907, "longitude": -96.82060}' https://sizeup.firstduesizeup.com/fd-api/v1/nfirs-notifications/number/2021-00001/apparatuses/code/R2
$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X PUT -d '{"is_aid": false, "dispatch_at": "2019-02-16T19:42:00+00:004", "arrive_at": "2019-02-16T19:42:00+00:004", "dispatch_acknowledged_at": "2019-02-16T19:42:00+00:004", "enroute_at": "2019-02-16T19:42:00+00:004", "clear_at": "2019-02-16T19:42:00+00:004", "back_in_service_at": "2019-02-16T19:42:00+00:004", "canceled_at": "2019-02-16T19:42:00+00:004", "patient_arrived_at": "2019-02-16T19:42:00+00:004", "patient_transferred_at": "2019-02-16T19:42:00+00:004", "canceled_stage_code": "on_scene", "response_mode": 4, "notes": "This is a narrative"}' https://sizeup.firstduesizeup.com/fd-api/v1/nfirs-notifications/number/2021-00001/apparatuses/code/R2

Success Response

HTTP/1.1 204 No Content

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "The requested item does not exist or access denied."
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": "Validation Failed. Please provide unit_code parameter.",
  "errors": [
    {
      "field": "unit_code",
      "code": "missing_field",
      "message": "Please provide unit_code parameter."
    }
  ]
}

PUT /fd-api/v1/nfirs-notifications/dispatch-number/:dispatch_number/apparatuses/code/:unit_code

Update NFIRS notification apparatus item completely.

PUT /fd-api/v1/nfirs-notifications/dispatch-number/:dispatch_number/apparatuses/code/:unit_code

Parameters

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X PUT -d '{"is_aid": false, "dispatch_at": "2019-02-16T19:42:00+00:004", "arrive_at": "2019-02-16T19:42:00+00:004", "dispatch_acknowledged_at": "2019-02-16T19:42:00+00:004", "enroute_at": "2019-02-16T19:42:00+00:004", "clear_at": "2019-02-16T19:42:00+00:004", "back_in_service_at": "2019-02-16T19:42:00+00:004", "canceled_at": "2019-02-16T19:42:00+00:004", "patient_arrived_at": "2019-02-16T19:42:00+00:004", "patient_transferred_at": "2019-02-16T19:42:00+00:004", "canceled_stage_code": "on_scene", "response_mode": 4, "latitude": 32.9515907, "longitude": -96.82060}' https://sizeup.firstduesizeup.com/fd-api/v1/nfirs-notifications/dispatch-number/2021-00001/apparatuses/code/R2
$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X PUT -d '{"is_aid": false, "dispatch_at": "2019-02-16T19:42:00+00:004", "arrive_at": "2019-02-16T19:42:00+00:004", "dispatch_acknowledged_at": "2019-02-16T19:42:00+00:004", "enroute_at": "2019-02-16T19:42:00+00:004", "clear_at": "2019-02-16T19:42:00+00:004", "back_in_service_at": "2019-02-16T19:42:00+00:004", "canceled_at": "2019-02-16T19:42:00+00:004", "patient_arrived_at": "2019-02-16T19:42:00+00:004", "patient_transferred_at": "2019-02-16T19:42:00+00:004", "canceled_stage_code": "on_scene", "response_mode": 4, "notes": "This is a narrative"}' https://sizeup.firstduesizeup.com/fd-api/v1/nfirs-notifications/dispatch-number/2021-00001/apparatuses/code/R2

Success Response

HTTP/1.1 204 No Content

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "The requested item does not exist or access denied."
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": "Validation Failed. Please provide unit_code parameter.",
  "errors": [
    {
      "field": "unit_code",
      "code": "missing_field",
      "message": "Please provide unit_code parameter."
    }
  ]
}

DELETE /fd-api/v1/nfirs-notifications/:nfirs_notification_id/apparatuses/:id

Delete NFIRS notification apparatus item.

DELETE /fd-api/v1/nfirs-notifications/:nfirs_notification_id/apparatuses/:id

Parameters

Example Requests

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X DELETE https://sizeup.firstduesizeup.com/fd-api/v1/nfirs-notifications/24/apparatuses/25

Success Response

HTTP/1.1 204 No Content

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "The requested item does not exist or access denied."
}

DELETE /fd-api/v1/nfirs-notifications/number/:incident_number/apparatuses/code/:unit_code

Delete NFIRS notification apparatus item.

DELETE /fd-api/v1/nfirs-notifications/number/:incident_number/apparatuses/code/:unit_code

Parameters

Example Requests

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X DELETE https://sizeup.firstduesizeup.com/fd-api/v1/nfirs-notifications/number/2021-00001/apparatuses/code/R2

Success Response

HTTP/1.1 204 No Content

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "The requested item does not exist or access denied."
}

DELETE /fd-api/v1/nfirs-notifications/dispatch-number/:dispatch_number/apparatuses/code/:unit_code

Delete NFIRS notification apparatus item.

DELETE /fd-api/v1/nfirs-notifications/dispatch-number/:incident_number/apparatuses/code/:unit_code

Parameters

Example Requests

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X DELETE https://sizeup.firstduesizeup.com/fd-api/v1/nfirs-notifications/number/2021-00001/apparatuses/code/R2

Success Response

HTTP/1.1 204 No Content

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "The requested item does not exist or access denied."
}

POST /fd-api/v1/nfirs-notifications/:nfirs_notification_id/apparatuses/:nfirs_apparatus_id/personnel

Create a NFIRS notification personnel.

POST /fd-api/v1/nfirs-notifications/:nfirs_notification_id/apparatuses/:nfirs_apparatus_id/personnel

Parameters

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X POST -d '{"xref_id": "NNP-01", "first_name": "FIRST_NAME", "middle_initial": "MIDDLE_INITIAL", "last_name": "LAST_NAME", "personnel_agency_id": "PA-01"}' https://sizeup.firstduesizeup.com/fd-api/v1/nfirs-notifications/24/apparatuses/25/personnel

Success Response

HTTP/1.1 201 Created
{
  "id": 333
}

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

HTTP/1.1 409 Conflict
{
  "code": 0,
  "message": "Object already exists."
}

POST /fd-api/v1/nfirs-notifications/number/:incident_number/apparatuses/code/:unit_code/personnel

Create a NFIRS notification personnel.

POST /fd-api/v1/nfirs-notifications/number/:incident_number/apparatuses/code/:unit_code/personnel

Parameters

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X POST -d '{"xref_id": "NNP-01", "first_name": "FIRST_NAME", "middle_initial": "MIDDLE_INITIAL", "last_name": "LAST_NAME", "personnel_agency_id": "PA-01"}' https://sizeup.firstduesizeup.com/fd-api/v1/nfirs-notifications/number/2021-00001/apparatuses/code/R2/personnel

Success Response

HTTP/1.1 204 No Content

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

HTTP/1.1 409 Conflict
{
  "code": 0,
  "message": "Object already exists."
}

POST /fd-api/v1/nfirs-notifications/dispatch-number/:dispatch_number/apparatuses/code/:unit_code/personnel

Create a NFIRS notification personnel.

POST /fd-api/v1/nfirs-notifications/dispatch-number/:dispatch_number/apparatuses/code/:unit_code/personnel

Parameters

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X POST -d '{"xref_id": "NNP-01", "first_name": "FIRST_NAME", "middle_initial": "MIDDLE_INITIAL", "last_name": "LAST_NAME", "personnel_agency_id": "PA-01"}' https://sizeup.firstduesizeup.com/fd-api/v1/nfirs-notifications/dispatch-number/2021-00001/apparatuses/code/R2/personnel

Success Response

HTTP/1.1 204 No Content

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

HTTP/1.1 409 Conflict
{
  "code": 0,
  "message": "Object already exists."
}

PUT /fd-api/v1/nfirs-notifications/:nfirs_notification_id/apparatuses/:nfirs_apparatus_id/personnel/:id

Update NFIRS notification personnel item completely.

PUT /fd-api/v1/nfirs-notifications/:nfirs_notification_id/apparatuses/:nfirs_apparatus_id/personnel/:id

Parameters

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X PUT -d '{"xref_id": "NNP-01", "first_name": "FIRST_NAME", "middle_initial": "MIDDLE_INITIAL", "last_name": "LAST_NAME", "personnel_agency_id": "PA-01"}' https://sizeup.firstduesizeup.com/fd-api/v1/nfirs-notifications/24/apparatuses/25/personnel/35

Success Response

HTTP/1.1 204 No Content

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "The requested item does not exist or access denied."
}

PUT /fd-api/v1/nfirs-notifications/number/:incident_number/apparatuses/code/:unit_code/personnel/xref/:xref_id

Update NFIRS notification personnel item completely.

PUT /fd-api/v1/nfirs-notifications/number/:incident_number/apparatuses/code/:unit_code/personnel/xref/:xref_id

Parameters

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X PUT -d '{"first_name": "FIRST_NAME", "middle_initial": "MIDDLE_INITIAL", "last_name": "LAST_NAME", "personnel_agency_id": "PA-01"}' https://sizeup.firstduesizeup.com/fd-api/v1/nfirs-notifications/number/2021-00001/apparatuses/code/R2/personnel/xref/NNP-01

Success Response

HTTP/1.1 204 No Content

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "The requested item does not exist or access denied."
}

PUT /fd-api/v1/nfirs-notifications/dispatch-number/:dispatch_number/apparatuses/code/:unit_code/personnel/xref/:xref_id

Update NFIRS notification personnel item completely.

PUT /fd-api/v1/nfirs-notifications/dispatch-number/:dispatch_number/apparatuses/code/:unit_code/personnel/xref/:xref_id

Parameters

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X PUT -d '{"first_name": "FIRST_NAME", "middle_initial": "MIDDLE_INITIAL", "last_name": "LAST_NAME", "personnel_agency_id": "PA-01"}' https://sizeup.firstduesizeup.com/fd-api/v1/nfirs-notifications/dispatch-number/2021-00001/apparatuses/code/R2/personnel/xref/NNP-01

Success Response

HTTP/1.1 204 No Content

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "The requested item does not exist or access denied."
}

DELETE /fd-api/v1/nfirs-notifications/:nfirs_notification_id/apparatuses/:nfirs_apparatus_id/personnel/:id

Delete NFIRS notification personnel item.

DELETE /fd-api/v1/nfirs-notifications/:nfirs_notification_id/apparatuses/:nfirs_apparatus_id/personnel/:id

Parameters

Example Requests

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X DELETE https://sizeup.firstduesizeup.com/fd-api/v1/nfirs-notifications/24/apparatuses/25/personnel/35

Success Response

HTTP/1.1 204 No Content

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "The requested item does not exist or access denied."
}

DELETE /fd-api/v1/nfirs-notifications/number/:incident_number/apparatuses/code/:unit_code/personnel/xref/:xref_id

Delete NFIRS notification personnel item.

DELETE /fd-api/v1/nfirs-notifications/number/:incident_number/apparatuses/code/:unit_code/personnel/xref/:xref_id

Parameters

Example Requests

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X DELETE https://sizeup.firstduesizeup.com/fd-api/v1/nfirs-notifications/number/2021-00001/apparatuses/code/R2/personnel/xref/NNP-01

Success Response

HTTP/1.1 204 No Content

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "The requested item does not exist or access denied."
}

DELETE /fd-api/v1/nfirs-notifications/dispatch-number/:dispatch_number/apparatuses/code/:unit_code/personnel/xref/:xref_id

Delete NFIRS notification personnel item.

DELETE /fd-api/v1/nfirs-notifications/dispatch-number/:dispatch_number/apparatuses/code/:unit_code/personnel/xref/:xref_id

Parameters

Example Requests

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X DELETE https://sizeup.firstduesizeup.com/fd-api/v1/nfirs-notifications/dispatch-number/2021-00001/apparatuses/code/R2/personnel/xref/NNP-01

Success Response

HTTP/1.1 204 No Content

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "The requested item does not exist or access denied."
}

GET /fd-api/v1/apparatuses/get-all-details

Get all apparatuses.

GET /fd-api/v1/apparatuses/get-all-details

Parameters

Example Requests

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X GET https://sizeup.firstduesizeup.com/fd-api/v1/apparatuses/get-all-details

Success Response

HTTP/1.1 200 OK

{
    "status": "success",
    "message": "Apparatuses retrieved successfully",
    "page": 1,
    "page_size": 20,
    "total": 1,
    "total_pages": 1,
    "links": [],
    "params": {
        "search": "p1",
        "apparatus_group": "ng"
    },
    "results": [
        {
            "id": 836,
            "nfirs_id": "33",
            "apparatus_type_code": "11",
            "vehicle_number": "33",
            "primary_use_code": "1",
            "created_at": "2022-10-07 13:23:34.998908",
            "vehicle_id": "2",
            "name": "APP1",
            "unit_call_sign": "QW2",
            "vin_number": null,
            "license_plate": null,
            "dot_number": null,
            "license_plate_state_code": null,
            "manufacturer": null,
            "manufacture_year": null,
            "model": null,
            "engine": null,
            "tank_volume": null,
            "pump_type": null,
            "pump_manufacturer": null,
            "vehicle_initial_cost": null,
            "date_in_service": null,
            "year_replacement": null,
            "in_service": true,
            "inspection_freq_type_code": null,
            "aid_type_auto": false,
            "aid_type_mutual": false,
            "ownership_type_code": null,
            "batt_dept_id": 838,
            "normal_staffing_level": null,
            "provides_als_support": false,
            "owner_type_code": "department",
            "aid_department_name": null,
            "fire_station_id": null,
            "gallons_water": null,
            "odometer": "1000.00",
            "pto_hours": "100.00",
            "engine_hours": "100.00",
            "is_deleted": false,
            "apparatus_group_id": 109,
            "deleted_by": null,
            "deleted_at": null,
            "starting_aerial_hours": "123.00",
            "manufacture_month": null,
            "nemsis_vehicle_type_code": null,
            "crew_state_level_code": null,
            "grant_year": null,
            "vehicle_initial_cost_after_manufacturing_year": null,
            "purchase_price": null,
            "grant_name": null,
            "is_grant_purchase": false,
            "description": null,
            "is_primary": true,
            "unit_transport_equipment_capability_code": null,
            "gallons_foam": null,
            "assigned_user_id": null,
            "tire_size": null,
            "tire_pressure": null,
            "pump_size": null,
            "ladder_length": null,
            "aerial_type": null,
            "ambulance_type": null,
            "manufacturer_build": null,
            "manufacturer_id": null,
            "pump_hours": "223.00",
            "tire_pressure_front": null,
            "liters_water": null,
            "tire_pressure_rear": null,
            "unit_user_id": null,
            "liters_foam": null,
            "batt_dept_aid_id": null,
            "pump_model": null,
            "pump_serial_number": null,
            "fema_cost_code_id": null,
            "is_archived": false,
            "funding_source": null,
            "height": null,
            "length": null,
            "weight": null,
            "front_tire_size": null,
            "rear_tire_size": null,
            "api_apparatus_id": null,
            "max_persons": null,
            "max_gross_load": null,
            "persons_motor_equip": null,
            "fuel_capacity": null,
            "fresh_water": null,
            "grey_water": null,
            "number_of_motors": null,
            "initial_in_service_date": null,
            "cab_type": null,
            "body_class": null,
            "engine_cylinders": null,
            "displacement_cc": null,
            "displacement_ci": null,
            "displacement_l": null,
            "drive_type": null,
            "engine_power_kw": null,
            "gvwr": null,
            "gvwr_class": null,
            "fuel_type": null,
            "end_of_primary_service_life_date": null,
            "samsara_id": null,
            "end_of_service_life_date": null,
            "uuid": "f5cdef6d-fa06-4d84-834d-ca8c291ad39e",
            "neris_unit_id": null,
            "manufacture_date": null,
            "client_code": "ASHEVILLE"
        }
    ]
}

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

HTTP/1.1 422 Unprocessable entity
{
    "code": 0,
    "message": "Validation Failed. Please provide valid search, apparatus_group parameters.",
    "errors": [
        {
            "field": "search",
            "code": "invalid",
            "message": "Please provide a valid search."
        },
        {
            "field": "apparatus_group",
            "code": "invalid",
            "message": "Please provide a valid apparatus_group."
        }
    ]
}

GET /fd-api/v1/apparatuses/unit-call-signs

Get apparatus unit call signs.

GET /fd-api/v1/apparatuses/unit-call-signs

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" https://sizeup.firstduesizeup.com/fd-api/v1/apparatuses/unit-call-signs

Success Response

HTTP/1.1 200 OK
['CODE1', 'CODE2', 'CODE3']

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

GET /fd-api/v1/apparatuses/vehicle-number/:vehicle_number

Get id, odometer, engine_hours, pto_hours and pump_hours of the apparatuses with vehicle number :vehicle_number.

GET /fd-api/v1/apparatuses/vehicle-number/:vehicle_number

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" https://sizeup.firstduesizeup.com/fd-api/v1/apparatuses/vehicle-number/23

Success Response

HTTP/1.1 200 OK

[
  {
    "id": 25,
    "odometer": 45,
    "engine_hours": 3,
    "pto_hours": 4,
    "pump_hours": 1
  },
  {
    ....
  }
]

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "Apparatus not found."
}

GET /fd-api/v1/apparatuses/api-apparatus-id/:api_apparatus_id

Get id, odometer, engine_hours, pto_hours and pump_hours of the apparatuses with api apparatus id :api_apparatus_id.

GET /fd-api/v1/apparatuses/api-apparatus-id/:api-apparatus-id

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" https://sizeup.firstduesizeup.com/fd-api/v1/apparatuses/api-apparatus-id/723

Success Response

HTTP/1.1 200 OK

[
  {
    "id": 25,
    "odometer": 45,
    "engine_hours": 3,
    "pto_hours": 4,
    "pump_hours": 1
  },
  {
    ....
  }
]

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "Apparatus not found."
}

GET /fd-api/v1/asset-work-order-boards

Get all asset work order boards.

GET /fd-api/v1/asset-work-order-boards

Parameters

Example Requests

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X GET https://sizeup.firstduesizeup.com/fd-api/v1/asset-work-order-boards

Success Response

HTTP/1.1 200 OK

{
    "status": "success",
    "message": "Work orders Board retrieved successfully",
    "page": 2,
    "page_size": 20,
    "total": 52,
    "total_pages": 3,
    "links": {
        "first": "https://sizeup.firstduesizeup.test/fd-api/v1/asset-work-order-boards?page_size=20&is_active=true&page=1",
        "prev": "https://sizeup.firstduesizeup.test/fd-api/v1/asset-work-order-boards?page_size=20&is_active=true&page=1",
        "next": "https://sizeup.firstduesizeup.test/fd-api/v1/asset-work-order-boards?page_size=20&is_active=true&page=3",
        "last": "https://sizeup.firstduesizeup.test/fd-api/v1/asset-work-order-boards?page_size=20&is_active=true&page=3"
    },
    "params": {
        "name": "",
        "is_active": "true"
    },
    "results": [
        {
            "id": 100,
            "name": "Prueba 000112",
            "is_active": true,
            "status": "Active",
            "created_at": "09/16/2021",
            "updated_at": "08/31/2022"
        },
        ...
    ]
}

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

HTTP/1.1 422 Unprocessable entity
{
    "code": 0,
    "message": "Validation Failed. Please provide valid name, is_active parameters.",
    "errors": [
        {
            "field": "name",
            "code": "missing_field",
            "message": "Please provide a valid name."
        },
        {
            "field": "is_active",
            "code": "missing_field",
            "message": "Please provide a valid is_active."
        }
    ]
}

GET /fd-api/v1/asset-work-orders

Get all asset work order.

GET /fd-api/v1/asset-work-orders

Parameters

Example Requests

$ curl -i -k -H "Authorization: Bearer 47dad9f9e1e5e2b2be5dd5a" https://sizeup.firstduesizeup.com/fd-api/v1/asset-work-orders

Success Response

HTTP/1.1 200 OK

{
    "status": "success",
    "message": "Work orders retrieved successfully",
    "page": 1,
    "page_size": 20,
    "total": 28,
    "total_pages": 2,
    "links": {
        "next": "https://sizeup.firstduesizeup.test/fd-api/v1/asset-work-orders?page=2",
        "last": "https://sizeup.firstduesizeup.test/fd-api/v1/asset-work-orders?page=2"
    },
    "params": [
        "search": null,
        "board_id": null,
        "asset_type_code": null,
        "datetime_from": null,
        "datetime_to": null,
    ],
    "results": [
        {
            "id": 219,
            "summary": "Preventative Maintenance",
            "status_name": "4",
            "number": 76,
            "eta": null,
            "priority_level_code": "low",
            "submitted_by": "User #2127",
            "created_at": "2025-04-23 15:45:09.262374",
            "created_by": "User #2127",
            "updated_at": null,
            "is_archived": false,
            "is_change_asset_allowed": false,
            "has_attachment": false,
            "incident_number": null,
            "description": "Preventative Maintenance",
            "work_performed": null,
            "apparatus_engine_hours": "999999.00",
            "apparatus_odometer": "132.00",
            "apparatus_pto_hours": "1.00",
            "apparatus_pump_hours": "5.00",
            "apparatus_starting_aerial_hours": "5.00",
            "apparatus": {
                "id": 528,
                "name": "APP01"
            },
            "fire_station": null,
            "kit": null,
            "equipment": null,
            "asset_work_order_board": {
                "id": 109,
                "name": "CWOB"
            },
            "vendor": null,
            "asset_work_order_type": {
                "id": 137,
                "name": "B3"
            },
            "teams": [
                {
                  "id": 60,
                  "name": "Team 006"
                },
                {
                  "id": 57,
                  "name": "Team 005"
                },
                {
                  "id": 56,
                  "name": "Team 004"
                },
                {
                  "id": 54,
                  "name": "Team 003"
                },
                {
                  "id": 52,
                  "name": "Team 002"
                },
                {
                  "id": 51,
                  "name": "Team 001"
                },
                {
                  "id": 50,
                  "name": "Prueba"
                }
            ],
            "users": []
        },
        ....
    ]
}

Error Response

HTTP/1.1 401 Unauthorized
{
    "code": 0,
    "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
    "code": 0,
    "message": "You are not authorized to perform this action."
}

HTTP/1.1 422 Unprocessable entity
{
    "code": 0,
    "message": "Validation Failed. Please provide valid asset_type_code parameter.",
    "errors": [
        {
            "field": "asset_type_code",
            "code": "invalid",
            "message": "Invalid asset type code."
        }
   ]
}

GET /fd-api/v1/asset-work-orders/:id

Get an Asset work order.

GET /fd-api/v1/asset-work-orders/:id

Parameters

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" https://sizeup.firstduesizeup.com/fd-api/v1/asset-work-orders/130

Success Response

HTTP/1.1 200 OK
{
    "id": 130,
    "summary": "1111",
    "submitted_by": "AshevilleFire Admin",
    "number": 1,
    "created_by": "AshevilleFire Admin",
    "updated_by": "AshevilleFire Admin",
    "eta": null,
    "is_archived": false,
    "is_change_asset_allowed": true,
    "created_at": "2025-05-21 20:46:15.607457",
    "updated_at": "2025-05-22 16:07:22.98951",
    "archived_at": null,
    "incident_number": "",
    "description": "1111",
    "work_performed": "11111",
    "apparatus_engine_hours": "0.00",
    "apparatus_odometer": "0.00",
    "apparatus_pto_hours": "0.00",
    "apparatus_pump_hours": "0.00",
    "apparatus_starting_aerial_hours": null,
    "has_attachment": false,
    "priority_level_code": "low",
    "asset_work_order_status": {
        "id": 231,
        "name": "1"
    },
    "asset_work_order_type": {
        "id": 137,
        "name": "B3"
    },
    "asset_work_order_board": {
        "id": 109,
        "name": "CWOB"
    },
    "apparatus": {
        "id": 901,
        "name": "AAAAAAA"
    },
    "equipment": null,
    "fire_station": null,
    "kit": null,
    "asset_work_order_vendor": null,
    "asset_work_order_teams": [
        {
            "id": 50,
            "name": "Prueba"
        },
        {
            "id": 51,
            "name": "Team 001"
        },
        {
            "id": 52,
            "name": "Team 002"
        },
        {
            "id": 54,
            "name": "Team 003"
        },
        {
            "id": 56,
            "name": "Team 004"
        },
        {
            "id": 57,
            "name": "Team 005"
        },
        {
            "id": 60,
            "name": "Team 006"
        }
    ],
    "asset_work_order_users": null
}

Error Response

HTTP/1.1 401 Unauthorized
{
    "code": 0,
    "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
    "code": 0,
    "message": "You are not authorized to perform this action."
}

GET /fd-api/v1/asset-work-orders/stats

Get all asset work order stats.

GET /fd-api/v1/asset-work-orders/stats

Parameters

Example Requests

$ curl -i -k -H "Authorization: Bearer 47dad9f9e1e5e2b2be5dd5a" https://sizeup.firstduesizeup.com/fd-api/v1/asset-work-orders/stats

Success Response

HTTP/1.1 200 OK

{
  "params": {
      "asset_type_code": null,
      "datetime_from": null,
      "datetime_to": null
  },
  "total_work_orders": 33,
  "by_asset_type": {
      "Apparatus": 17,
      "Equipment": 14,
      "Fire Station": 2,
      "Kit": 0
  },
  "by_status": {
      "Ph 22": 1,
      "1": 12,
      "4": 15,
      "Ph 1": 5
  }
}

Error Response

HTTP/1.1 401 Unauthorized
{
    "code": 0,
    "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
    "code": 0,
    "message": "You are not authorized to perform this action."
}

HTTP/1.1 422 Unprocessable entity
{
    "code": 0,
    "message": "Validation Failed. Please provide valid asset_type_code parameter.",
    "errors": [
        {
            "field": "asset_type_code",
            "code": "invalid",
            "message": "Invalid asset type code."
        }
   ]
}

PATCH /fd-api/v1/apparatuses/:id

Update odometer, engine_hours, pto_hours and/or pump_hours field of :id apparatus. The requests should be at least one parameter. Parameter values should be numeric, greater than 0 and its current value

PATCH /fd-api/v1/apparatuses/:id

Parameters

Example Requests

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X PATCH -d '{"odometer": 20.50, "engine_hours": 5000.0}' https://sizeup.firstduesizeup.com/fd-api/v1/apparatuses/456

Success Response

HTTP/1.1 200 OK

[]

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "Apparatus not found."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "Empty request data"
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "Invalid param: {text}, each should be numeric greater than 0.|Invalid params: {text}, each should be numeric greater than 0"
}

HTTP/1.1 422 Unprocessable entity
{
  "code": 0,
  "message": "Invalid values.",
  "errors": [
    {
      "field": "odometer",
      "code": "invalid_field",
      "message": "Invalid odometer value, should be greater than current value."
    },
    {
      "field": "engine_hours",
      "code": "invalid_field",
      "message": "Invalid engine hours value, should be greater than current value."
    },
    {
      "field": "pto_hours",
      "code": "invalid_field",
      "message": "Invalid PTO hours value, should be greater than current value."
    },
    {
      "field": "pump_hours",
      "code": "invalid_field",
      "message": "Invalid pump hours value, should be greater than current value."
    }
  ]
}

HTTP/1.1 422 Unprocessable entity
{
  "code": 0,
  "message": "Error updating apparatus."
}

GET /fd-api/v1/apparatuses/:apparatus_id

Retrieve all fields of an apparatus by its ID

GET /fd-api/v1/apparatuses/:apparatus_id

Example Requests

$ curl -i -k -H "Authorization: Bearer <YOUR_TOKEN_HERE>" https://sizeup.firstduesizeup.com/fd-api/v1/apparatuses/6

Success Response

HTTP/1.1 200 OK

{
  "id": 6,
  "name": "Tank 1",
  "manufacture_year": 1967,
  "manufacture_month": 12,
  "manufacturer": null,
  "vehicle_number": "Lorem ipsum dolor sit ame",
  "in_service": false,
  "model": null,
  "vehicle_id": "Lorem ipsum dolor sit ame",
  "nfirs_id": "666",
  "manufacturer_id": null,
  "unit_call_sign": "666",
  "vin_number": null,
  "gallons_water": null,
  "liters_water": null,
  "odometer": null,
  "pto_hours": null,
  "engine_hours": null,
  "apparatus_type_code": "00",
  "dot_number": null,
  "aid_type_auto": false,
  "license_plate_state_code": null,
  "provides_als_support": false,
  "primary_use_code": "0",
  "owner_type_code": "department",
  "license_plate": null,
  "starting_aerial_hours": null,
  "is_primary": false,
  "manufacturer_build": null,
  "is_grant_purchase": false,
  "grant_year": null,
  "grant_name": null,
  "purchase_price": null,
  "nemsis_vehicle_type_code": null,
  "unit_transport_equipment_capability_code": null,
  "description": null,
  "normal_staffing_level": null,
  "front_tire_size": null,
  "rear_tire_size": null,
  "tire_pressure": null,
  "tire_pressure_front": null,
  "tire_pressure_rear": null,
  "gallons_foam": null,
  "liters_foam": null,
  "pump_size": null,
  "pump_hours": null,
  "pump_model": null,
  "pump_serial_number": null,
  "pump_manufacturer": null,
  "aerial_type": null,
  "ladder_length": null,
  "ambulance_type": null,
  "vehicle_initial_cost_after_manufacturing_year": null,
  "aid_type_mutual": false,
  "funding_source": null,
  "height": null,
  "length": null,
  "weight": null,
  "is_archived": false,
  "api_apparatus_id": null,
  "max_persons": null,
  "max_gross_load": null,
  "persons_motor_equip": null,
  "samsara_id": null,
  "fuel_capacity": null,
  "fresh_water": null,
  "grey_water": null,
  "number_of_motors": null,
  "initial_in_service_date": null,
  "end_of_primary_service_life_date": null,
  "end_of_service_life_date": null,
  "status": "N",
  "fuel_type": null,
  "gvwr": null,
  "gvwr_class": null,
  "cab_type": null,
  "body_class": null,
  "engine_cylinders": null,
  "drive_type": null,
  "displacement_cc": null,
  "displacement_ci": null,
  "displacement_l": null,
  "engine_power_kw": null,
  "apparatus_type_code_name": "00",
  "primary_use_code_name": "0",
  "owner_type_code_name": "department",
  "manufacture_date": "1967-12-01",
  "created_at": "2021-02-28 13:06:07.929605",
  "apparatus_group": {
      "id": 74,
      "name": "Type 1 Engines"
  },
  "batt_dept": {
      "id": 861,
      "name": "Thomasville Fire"
  },
  "batt_dept_aid": null,
  "fire_station": null,
  "assigned_user": null,
  "unit_user": null
}

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

HTTP/1.1 404 Not Found
{
  "code": 0,
  "message": "Apparatus not found."
}

GET /fd-api/v1/apparatuses/:apparatus_id/work-orders

Get work orders for a specific apparatus.

GET /fd-api/v1/apparatuses/:apparatus_id/work-orders

Parameters

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" https://sizeup.firstduesizeup.com/fd-api/v1/apparatuses/155/work-orders

Success Response

HTTP/1.1 200 OK
{
    "status": "success",
    "message": "Apparatus Work orders retrieved successfully",
    "page": 1,
    "page_size": 20,
    "total": 1,
    "total_pages": 1,
    "links": [],
    "params": null,
    "results": [
        {
            "id": 125,
            "summary": "test number ",
            "status_name": "1",
            "number": 7,
            "eta": null,
            "priority_level_code": "high",
            "submitted_by": "Fire Department Admin - Abington FD",
            "created_at": "2025-03-10 16:53:21.230758",
            "created_by": "Fire Department Admin - Abington FD",
            "updated_at": "2025-05-21 15:38:43.773143",
            "is_archived": false,
            "is_change_asset_allowed": false,
            "incident_number": null,
            "apparatus_engine_hours": "125.00",
            "apparatus_odometer": "125.00",
            "apparatus_pto_hours": "125.00",
            "apparatus_pump_hours": null,
            "apparatus_starting_aerial_hours": "1202.00",
            "has_attachment": false,
            "description": "test number ",
            "work_performed": null,
            "apparatus": {
                "id": 155,
                "name": "App1"
            },
            "asset_work_order_board": {
                "id": 80,
                "name": "Test"
            },
            "vendor": null,
            "asset_work_order_type": {
                "id": 115,
                "name": "WOT1"
            },
            "teams": null,
            "users": [
                {
                    "id": 60316,
                    "name": "sucel WO"
                }
            ]
        }
    ]
}

Error Response

HTTP/1.1 401 Unauthorized
{
    "code": 0,
    "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
    "code": 0,
    "message": "You are not authorized to perform this action."
}

GET /fd-api/v1/locations

Get all locations.

GET /fd-api/v1/locations

Parameters

Example Requests

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X GET https://sizeup.firstduesizeup.com/fd-api/v1/locations

Success Response

HTTP/1.1 200 OK

{
    "status": "success",
    "message": "Locations retrieved successfully",
    "page": 1,
    "page_size": 20,
    "total": 1,
    "total_pages": 1,
    "links": [],
    "params": {
        "name": "104"
    },
    "results": [
        {
            "id": 200,
            "station_num": "Station 104",
            "description": "ASHEVILLE FD (NC) #Station 104",
            "address": "Asheville Highway, Inman, Carolina del Sur, EE. UU.",
            "address1": null,
            "address2": null,
            "phone": null,
            "latitude": "35.0425240",
            "longitude": "-82.0909284",
            "geom": "0101000020E6100000C4115AC5D18554C0C6A52A6D71854140",
            "county_code": null,
            "station_nfirs_id": null,
            "neris_station_id": null,
            "city": null,
            "zip": null,
            "state_code": null,
            "year_built": null,
            "department": {
                "id": 838,
                "name": "ASHEVILLE FD (NC)"
            },
            "fire_zone": null,
            "fire_station_group": {
                "id": 3,
                "name": "GST2"
            }
        }
    ]
}

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

GET /fd-api/v1/locations/:id

Get a location by ID. Requires bearer authentication and permission: "FD API - Read Locations".

GET /fd-api/v1/locations/:id

Parameters

Example Requests

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X GET https://sizeup.firstduesizeup.com/fd-api/v1/locations/1

Success Response

HTTP/1.1 200 OK
{
    "id": 1,
    "station_num": "Emergency Management",
    "description": null,
    "address": "100 Court Plaza, Asheville, NC 28801, USA",
    "address1": null,
    "address2": null,
    "phone": null,
    "latitude": "35.5948248",
    "longitude": "-82.5500137",
    "geom": "0101000020E61000008676A96C33A354C0C46C133823CC4140",
    "county_code": "37021",
    "station_nfirs_id": null,
    "neris_station_id": null,
    "city": null,
    "zip": null,
    "state_code": null,
    "year_built": null,
    "department": {
        "id": 838,
        "name": "ASHEVILLE FD (NC)"
    },
    "fire_zone": null,
    "fire_station_group": null
}

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

HTTP/1.1 404 Not Found
{
  "code": 0,
  "message": "Location not found."
}

GET /fd-api/v1/logs/settings

Get Settings for Logs.

GET /fd-api/v1/logs/settings

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" https://sizeup.firstduesizeup.com/fd-api/v1/logs/settings

Success Response

{ "is_fdapi_log_enabled": true }

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

POST /fd-api/v1/logs

Import a log entry.

POST /fd-api/v1/logs

Parameters

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X POST -d '[{"message": "Log1", "level_code": "error", "category": "application"}]' https://sizeup.firstduesizeup.com/fd-api/v1/logs

Success Response

HTTP/1.1 204 No Content

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": "Validation Failed. Max items allowed exceeded.",
  "errors": []
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": Validation Failed. Empty parameters.",
  "errors": []
}

POST /fd-api/v1/logs/batch

Import a bunch of log entries. This will create every single entry.

POST /fd-api/v1/logs

Parameters is an array of objects. Max size is 1000 items.

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X POST -d '[{"message": "Log1", "level_code": "error", "category": "application"}]' https://sizeup.firstduesizeup.com/fd-api/v1/logs/batch

Success Response

HTTP/1.1 204 No Content

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": "Validation Failed. Max items allowed exceeded.",
  "errors": []
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": Validation Failed. Empty parameters.",
  "errors": []
}

GET /fd-api/v1/schedule

Get the schedule from the Shift Board for a given date range. Note most timestamps in this response are in the format YYYY-MM-DD HH:mm:ss, and are always considered local time. This is to conserve "wall time" or "clock time" data even if timezones are subject to change in the future.

GET /fd-api/v1/schedule

Parameters

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -G --data-urlencode "start=2022-03-01T08:00:00+00:00" --data-urlencode "end=2022-03-02T08:00:00+00:00" https://sizeup.firstduesizeup.com/fd-api/v1/schedule

Success Response

[
  {
    "date": "2022-03-21",
    "rotations": [
      {
        "id": 53,
        "name": "A Shift",
        "color": "#f44336"
      }
    ],
    "assignments": [
      {
        "id": 4,
        "start_at_local": "2022-03-21 08:00:00",
        "end_at_local": "2022-03-22 08:00:00",
        "name": "Station 1",
        "city": "Seattle",
        "pos": 1,
        "schedule_group_id": 1,
        "is_archived": false,
        "positions": [
          {
            "id": 1,
            "qualifier": {
              "id": 1,
              "name": "Captain",
              "shortcode": "CPT",
              "color": "#FF5722"
            },
            "work_shifts": [
              {
                "id": 146,
                "start_date": "2022-02-24",
                "end_date": "2038-01-01",
                "notes": "",
                "work_type": {
                  "id": 16,
                  "name": "Overtime",
                  "color": "#ff9800"
                },
                "work_subtype": null,
                "user": {
                  "id": 3089,
                  "first_name": "John",
                  "last_name": "Doe",
                  "qualifiers": [],
                  "is_active": true
                },
                "kelly_days": null,
                "type": "userRotation",
                "segments": [],
                "rotation": {
                  "id": 53,
                  "name": "A Shift",
                  "color": "#f44336"
                }
              }
            ],
            "vacancy_segments": [],
            "pos": 1,
            "is_vacant": true,
            "is_extra_vacancy": false
          },
          {
            "id": 2,
            "qualifier": {
              "id": 2,
              "name": "Firefighter",
              "shortcode": "FF-1",
              "color": "#3f51b5"
            },
            "work_shifts": [],
            "vacancy_segments": [],
            "pos": 2,
            "is_vacant": true,
            "is_extra_vacancy": false
          }
        ],
        "is_recurring": true,
        "range_start": "2020-09-22 08:00:00",
        "range_end": "2038-01-01 08:00:00",
        "duration_hours": 24
      },
      {
        "id": 35,
        "start_at_local": "2022-03-21 03:00:00",
        "end_at_local": "2022-03-21 08:00:00",
        "name": "Station 2",
        "city": "",
        "pos": 12,
        "schedule_group_id": null,
        "is_archived": false,
        "positions": [
          {
            "id": 90,
            "qualifier": null,
            "work_shifts": [],
            "vacancy_segments": [],
            "pos": 1,
            "is_vacant": true,
            "is_extra_vacancy": false
          },
          {
            "id": 91,
            "qualifier": null,
            "work_shifts": [],
            "vacancy_segments": [],
            "pos": 2,
            "is_vacant": true,
            "is_extra_vacancy": false
          }
        ],
        "is_recurring": true,
        "range_start": "2021-12-17 03:00:00",
        "range_end": "2038-01-01 08:00:00",
        "duration_hours": 5
      }
    ],
    "unassigned": [
      {
        "id": 147,
        "start_date": "2022-03-01",
        "end_date": "2038-01-01",
        "notes": null,
        "user": {
          "id": 3095,
          "first_name": "Jane",
          "last_name": "Doe",
          "qualifiers": [
            {
              "id": 1,
              "name": "Captain",
              "shortcode": "CPT",
              "color": "#FF5722"
            },
            {
              "id": 15,
              "name": "Emergency",
              "shortcode": "EMT",
              "color": "#cddc39"
            }
          ],
          "is_active": true
        },
        "assignment": null,
        "kelly_days": null,
        "type": "userRotation",
        "segments": [],
        "rotation": {
          "id": 53,
          "name": "A Shift",
          "color": "#f44336"
        }
      }
    ]
  }
]

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": "Validation Failed. Please provide a valid start parameter.",
  "errors": [
    {
      "field": "start",
      "code": "invalid",
      "message": "Please provide a date in ISO 8601 format, e.g. 2022-03-21T15:46:03+00:00"
    }
  ]
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": "Please choose a date range of max. 31 days."
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": "End cannot be before start, please check parameters."
}

GET /fd-api/v1/event-log/activities

GET /event-log/activities

GET https://sizeup.firstduesizeup.com/fd-api/v1/event-log/activities

Permission: apiReadEventLogActivities

Parameters

All query parameters are optional unless noted.

Allowed period values (exact strings):

day, today_and_yesterday, this_week, next_date, 3days, 7days, 30days, 90days, 180days, last24hrs, last3days, last7days, last30days, last90days, last180days, this_month, next_month, last_month, next_year, last_year, this_calendar_year, other.

Use period=other together with date_from / date_to for a custom range (or send either date alone — period becomes other automatically).

Response date vs filters: Each row’s date is the display value for the list (client-local, same style as the UI, e.g. n/j/Y), not necessarily ISO. Use year-first date_from / date_to when filtering — do not parse results[].date back as the filter format.

Example requests

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -G --data-urlencode "period=this_month" --data-urlencode "pageSize=50" "https://sizeup.firstduesizeup.com/fd-api/v1/event-log/activities"

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -G --data-urlencode "period=other" --data-urlencode "date_from=2026-08-01" --data-urlencode "date_to=2026-08-31" --data-urlencode "page_size=50" "https://sizeup.firstduesizeup.com/fd-api/v1/event-log/activities"

Success response

HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8

{
    "status": "success",
    "message": "Event log activities retrieved successfully",
    "next_cursor": "<opaque cursor from ActivityLog pagination>",
    "prev_cursor": null,
    "pageSize": 50,
    "params": {
        "name": null,
        "module": null,
        "status": null,
        "period": "this_month",
        "date_from": null,
        "date_to": null,
        "cursor": null,
        "direction": "next"
    },
    "results": [
        {
            "date": "8/15/2026",
            "module": "Event",
            "name": "Drill",
            "address": "123 Main St",
            "personnel": "Jane Doe",
            "apparatus": "E1",
            "status": "complete",
            "fireStations": "Station 1",
            "shifts": "A Shift",
            "passdowns": []
        }
    ]
}

Error response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

HTTP/1.1 500 Internal Server Error
{
  "code": 0,
  "message": "An unknown error occurred"
}

Unexpected failures while building the list (database errors, bugs, etc.) return 500 with this generic message; details are logged server-side only.

GET /fd-api/v1/ems-cases/:id

Get a EMS case.

GET /fd-api/v1/ems-cases/:id

Parameters

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" https://sizeup.firstduesizeup.com/fd-api/v1/ems-cases/111

Success Response

HTTP/1.1 200 OK
{
  "id": 1,
  "device_serial_number": "112223344444",
  "device_xref_id": "123498765",
  "device_model": "DEVICE_MODEL",
  "patient_xref_id": "09122022012365478",
  "case_xref_id": "09122022012365478",
  "case_started_at": "2022-02-16T19:42:00+00:00",
  "provider": "PROVIDER",
  "filename": "FILENAME",
  "patient_first_name": "PATIENT_FIRST_NAME",
  "patient_last_name": "PATIENT_LAST_NAME",
  "patient_middle_name": "PATIENT_MIDDLE_NAME",
  "patient_phone_number": "PATIENT_PHONE_NUMBER",
  "patient_email": "PATIENT_EMAIL",
  "patient_gender": "F",
  "patient_race": "PATIENT_RACE",
  "patient_age": 12,
  "patient_age_unit": "year",
  "patient_address": "PATIENT_ADDRESS",
  "patient_unit": "PATIENT_UNIT",
  "patient_cross_streets": "PATIENT_CROSS_STREETS",
  "patient_city": "PATIENT_CITY",
  "patient_state_code": "PATIENT_STATE_CODE",
  "patient_zip_code": "PATIENT_ZIP_CODE",
  "incident_location_type": "INCIDENT_LOCATION_TYPE",
  "incident_type": "INCIDENT_TYPE"
}

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

GET /fd-api/v1/ems-cases/case-xref-id/:case_xref_id

Get a EMS case.

GET /fd-api/v1/ems-cases/case-xref-id/:case_xref_id

Parameters

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" https://sizeup.firstduesizeup.com/fd-api/v1/ems-cases/case-xref-id/09122022012365478

Success Response

HTTP/1.1 200 OK
{
  "id": 1,
  "device_serial_number": "112223344444",
  "device_xref_id": "123498765",
  "device_model": "DEVICE_MODEL",
  "patient_xref_id": "09122022012365478",
  "case_xref_id": "09122022012365478",
  "case_started_at": "2022-02-16T19:42:00+00:00",
  "provider": "PROVIDER",
  "filename": "FILENAME",
  "patient_first_name": "PATIENT_FIRST_NAME",
  "patient_last_name": "PATIENT_LAST_NAME",
  "patient_middle_name": "PATIENT_MIDDLE_NAME",
  "patient_phone_number": "PATIENT_PHONE_NUMBER",
  "patient_email": "PATIENT_EMAIL",
  "patient_gender": "F",
  "patient_race": "PATIENT_RACE",
  "patient_age": 12,
  "patient_age_unit": "year",
  "patient_address": "PATIENT_ADDRESS",
  "patient_unit": "PATIENT_UNIT",
  "patient_cross_streets": "PATIENT_CROSS_STREETS",
  "patient_city": "PATIENT_CITY",
  "patient_state_code": "PATIENT_STATE_CODE",
  "patient_zip_code": "PATIENT_ZIP_CODE",
  "incident_location_type": "INCIDENT_LOCATION_TYPE",
  "incident_type": "INCIDENT_TYPE"
}

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

POST /fd-api/v1/ems-cases

Create a ENS case.

POST /fd-api/v1/ems-cases

Parameters

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X POST -d '{"device_serial_number": "112223344444", "device_xref_id": "123498765", "device_model": "DEVICE_MODEL", "patient_xref_id": "09122022012365478", "case_xref_id": "09122022012365478", "case_started_at": "2022-02-16T19:42:00+00:00", "provider": "PROVIDER", "filename": "FILENAME", "patient_first_name": "PATIENT_FIRST_NAME", "patient_last_name": "PATIENT_LAST_NAME", "patient_middle_name": "PATIENT_MIDDLE_NAME", "patient_phone_number": "PATIENT_PHONE_NUMBER","patient_email": "PATIENT_EMAIL", "patient_gender": "F", "patient_race": "PATIENT_RACE","patient_age": 12, "patient_age_unit": "year", "patient_address": "PATIENT_ADDRESS", "patient_unit": "PATIENT_UNIT", "patient_cross_streets": "PATIENT_CROSS_STREETS", "patient_city": "PATIENT_CITY", "patient_state_code": "PATIENT_STATE_CODE", "patient_zip_code": "PATIENT_ZIP_CODE", "incident_location_type": "INCIDENT_LOCATION_TYPE", "incident_type": "INCIDENT_TYPE"}' https://sizeup.firstduesizeup.com/fd-api/v1/ems-cases

Success Response

HTTP/1.1 201 Created
{
  "id": 111
}

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

HTTP/1.1 409 Conflict
{
  "code": 0,
  "message": "Object already exists."
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": "Validation Failed. Please provide address parameter.",
  "errors": [
    {
      "field": "patient_xref_id",
      "code": "missing_field",
      "message": "Please provide address parameter."
    }
  ]
}

PUT /fd-api/v1/ems-cases/:id

Update EMS case item completely.

PUT /fd-api/v1/ems-cases/:id

Parameters

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X PUT -d '{"device_serial_number": "112223344444", "device_xref_id": "123498765", "device_model": "DEVICE_MODEL", "patient_xref_id": "09122022012365478", "case_xref_id": "09122022012365478", "case_started_at": "2022-02-16T19:42:00+00:00", "provider": "PROVIDER", "filename": "FILENAME", "patient_first_name": "PATIENT_FIRST_NAME", "patient_last_name": "PATIENT_LAST_NAME", "patient_middle_name": "PATIENT_MIDDLE_NAME", "patient_phone_number": "PATIENT_PHONE_NUMBER","patient_email": "PATIENT_EMAIL", "patient_gender": "F", "patient_race": "PATIENT_RACE","patient_age": 12, "patient_age_unit": "year", "patient_address": "PATIENT_ADDRESS", "patient_unit": "PATIENT_UNIT", "patient_cross_streets": "PATIENT_CROSS_STREETS", "patient_city": "PATIENT_CITY", "patient_state_code": "PATIENT_STATE_CODE", "patient_zip_code": "PATIENT_ZIP_CODE", "incident_location_type": "INCIDENT_LOCATION_TYPE", "incident_type": "INCIDENT_TYPE"}' https://sizeup.firstduesizeup.com/fd-api/v1/ems-cases/111

Success Response

HTTP/1.1 204 No Content

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "The requested item does not exist or access denied."
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": "Validation Failed. Please provide address parameter.",
  "errors": [
    {
      "field": "patient_xref_id",
      "code": "missing_field",
      "message": "Please provide address parameter."
    }
  ]
}

DELETE /fd-api/v1/ems-cases/:id

Delete EMS case item.

DELETE /fd-api/v1/ems-cases/:id

Parameters

Example Requests

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X DELETE https://sizeup.firstduesizeup.com/fd-api/v1/ems-cases/111

Success Response

HTTP/1.1 204 No Content

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "The requested item does not exist or access denied."
}

GET /fd-api/v1/ems-cases/:ems_case_id/ems-case-vital-signs

Get EMS case vital signs

GET /fd-api/v1/ems-cases/:ems_case_id/ems-case-vital-signs

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -G --data-urlencode "since=2019-02-15T19:00:00+00:00" https://sizeup.firstduesizeup.com/fd-api/v1/ems-cases/111/ems-case-vital-signs

Success Response

HTTP/1.1 200 OK
[
  {
    "id": 123,
    "adjusted_at": "2022-02-16T19:42:00+00:00",
  },
  {
    ...
  }
]

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

POST /fd-api/v1/ems-cases/:ems_case_id/ems-case-vital-signs

Create a ENS case vital sign.

POST /fd-api/v1/ems-cases/:ems_case_id/ems-case-vital-signs

Parameters

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X POST -d '{"adjusted_at": "2022-02-16T19:42:00+00:004", "pta": 1, "level_of_responsiveness": "LEVEL_OF_RSPONSIVENESS", "heart_rate": "HEART_RATE", "pulse_rhythm": "PULSE_RHYTHM", "heart_rate_method": "HEART_RATE_METHOD", "systolic_blood_pressure": "SYSTOLIC_BLOOD_PRESSURE", "diastolic_blood_pressure": "DIASTOLIC_BLOOD_PRESSURE", "blood_pressure_method": "_BLOOD_PRESSURE_METHOD", "respiratory_rate": "RESPIRATORY_RATE", "respiratory_effort": "RESPIRATORY_EFFORT", "pulse_oximetry": "PULSE_OXIMETRY", "carbon_monoxide": "CARON_MONOXIDE", "pain": "PAIN", "pain_scale_type": "PAIN_SCALE_SCORE", "temperature_f": 10, "temperature_method": "TEMPERATURE_METHOD", "blood_glucose": "BLOOD_GLUCOSE", "interpretation_method": "INTERPRETATION_METHOD", "glasgow_coma_score_eye": "GLASGOW_COMA_SCORE_EYE", "glasgow_coma_score_verbal": "GLASGOW_COMA_SCORE_VERBAL", "glasgow_coma_score_motor": "GLASGOW_COMA_SCOREMOTOR", "glasgow_coma_score_qualifier": "GLASGOW_COMA_SCORE_QUALIFIER", "glasgow_coma_score_total": "GLASGOW_COMA_SCORE_TOTAL", "revised_trauma_score": "REVISED_TRAUMA_SCORE", "stroke_scale_score": "STROKE_SCALE_SCORE", "stroke_scale_type": "STROKE_SCALE_TYPE", "reperfusion_checklist_result": "REPERFUSION_CHECKLIST_RESULT", "end_tidal_carbon_dioxide": "END_TIDAL_CARBON_DIOXIDE", "carbon_dioxide_unit": "CARBON_DIOXIDE_UNIT", "trend_origin": "TREND_ORIGIN", "end_tidal_carbon_dioxide_type": "END_TIDAL_CARBON_DIOXIDE_TYPE", "mean_arterial_pressure": "MEAN_ARTERIAL_PRESSURE", "apgar_score": 1}' https://sizeup.firstduesizeup.com/fd-api/v1/ems-cases/111/ems-case-vital-signs

Success Response

HTTP/1.1 201 Created
{
  "id": 111
}

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

HTTP/1.1 409 Conflict
{
  "code": 0,
  "message": "Object already exists."
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": "Validation Failed. Please provide address parameter.",
  "errors": [
    {
      "field": "adjusted_at",
      "code": "missing_field",
      "message": "Please provide address parameter."
    }
  ]
}

PUT /fd-api/v1/ems-cases/:ems_case_id/ems-case-vital-signs/:id

Update EMS case vital sign item completely.

PUT /fd-api/v1/ems-cases/:ems_case_id/ems-case-vital-signs/:id

Parameters

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X PUT -d '{"adjusted_at": "2022-02-16T19:42:00+00:004", "pta": 1, "level_of_responsiveness": "LEVEL_OF_RSPONSIVENESS", "heart_rate": "HEART_RATE", "pulse_rhythm": "PULSE_RHYTHM", "heart_rate_method": "HEART_RATE_METHOD", "systolic_blood_pressure": "SYSTOLIC_BLOOD_PRESSURE", "diastolic_blood_pressure": "DIASTOLIC_BLOOD_PRESSURE", "blood_pressure_method": "_BLOOD_PRESSURE_METHOD", "respiratory_rate": "RESPIRATORY_RATE", "respiratory_effort": "RESPIRATORY_EFFORT", "pulse_oximetry": "PULSE_OXIMETRY", "carbon_monoxide": "CARON_MONOXIDE", "pain": "PAIN", "pain_scale_type": "PAIN_SCALE_SCORE", "temperature_f": 10, "temperature_method": "TEMPERATURE_METHOD", "blood_glucose": "BLOOD_GLUCOSE", "interpretation_method": "INTERPRETATION_METHOD", "glasgow_coma_score_eye": "GLASGOW_COMA_SCORE_EYE", "glasgow_coma_score_verbal": "GLASGOW_COMA_SCORE_VERBAL", "glasgow_coma_score_motor": "GLASGOW_COMA_SCOREMOTOR", "glasgow_coma_score_qualifier": "GLASGOW_COMA_SCORE_QUALIFIER", "glasgow_coma_score_total": "GLASGOW_COMA_SCORE_TOTAL", "revised_trauma_score": "REVISED_TRAUMA_SCORE", "stroke_scale_score": "STROKE_SCALE_SCORE", "stroke_scale_type": "STROKE_SCALE_TYPE", "reperfusion_checklist_result": "REPERFUSION_CHECKLIST_RESULT", "end_tidal_carbon_dioxide": "END_TIDAL_CARBON_DIOXIDE", "carbon_dioxide_unit": "CARBON_DIOXIDE_UNIT", "trend_origin": "TREND_ORIGIN", "end_tidal_carbon_dioxide_type": "END_TIDAL_CARBON_DIOXIDE_TYPE", "mean_arterial_pressure": "MEAN_ARTERIAL_PRESSURE", "apgar_score": 1}' https://sizeup.firstduesizeup.com/fd-api/v1/ems-cases/111/ems-case-vital-signs/111

Success Response

HTTP/1.1 204 No Content

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "The requested item does not exist or access denied."
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": "Validation Failed. Please provide address parameter.",
  "errors": [
    {
      "field": "adjusted_at",
      "code": "missing_field",
      "message": "Please provide address parameter."
    }
  ]
}

DELETE /fd-api/v1/ems-cases/:ems_case_id/ems-case-vital-signs:id

Delete EMS case vital sign item.

DELETE /fd-api/v1/ems-cases/:ems_case_id/ems-case-vital-signs/:id

Parameters

Example Requests

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X DELETE https://sizeup.firstduesizeup.com/fd-api/v1/ems-cases/111/ems-case-vital-signs/111

Success Response

HTTP/1.1 204 No Content

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "The requested item does not exist or access denied."
}

GET /fd-api/v1/ems-cases/:ems_case_id/ems-case-snapshots

Get EMS case snapshots.

GET /fd-api/v1/ems-cases/:ems_case_id/ems-case-snapshots

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -G --data-urlencode "since=2019-02-15T19:00:00+00:00" https://sizeup.firstduesizeup.com/fd-api/v1/ems-cases/111/ems-case-snapshots

Success Response

HTTP/1.1 200 OK
[
  {
    "id": 123,
    "recorded_at": "2022-02-16T19:42:00+00:00",
  },
  {
    ...
  }
]

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

POST /fd-api/v1/ems-cases/:ems_case_id/ems-case-snapshots

Create a EMS case snapshot.

POST /fd-api/v1/ems-cases/:ems_case_id/ems-case-snapshots

Parameters

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X POST -d '{"xref_id": "XREF_ID", "cardiac_rhythm": "CARDIAC_RHYTHM", "ecg_type": "RCG_TYPE", "length": "10:10:00", "recorded_at": "2022-02-16T19:42:00+00:004", "started_at": "2022-02-16T19:42:00+00:004", "treatment": "TREATMENT"}' https://sizeup.firstduesizeup.com/fd-api/v1/ems-cases/11/ems-case-snapshots

Success Response

HTTP/1.1 201 Created
{
  "id": 111
}

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

HTTP/1.1 409 Conflict
{
  "code": 0,
  "message": "Object already exists."
}

PUT /fd-api/v1/ems-cases/:ems_case_id/ems-case-snapshots/:id

Update EMS case snapshot item completely.

PUT /fd-api/v1/ems-cases/:ems_case_id/ems-case-snapshots/:id

Parameters

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X PUT -d '{"xref_id": "XREF_ID", "cardiac_rhythm": "CARDIAC_RHYTHM", "ecg_type": "RCG_TYPE", "length": "10:10:00", "recorded_at": "2022-02-16T19:42:00+00:004", "started_at": "2022-02-16T19:42:00+00:004", "treatment": "TREATMENT"}' https://sizeup.firstduesizeup.com/fd-api/v1/ems-cases/111/ems-case-snapshots/111

Success Response

HTTP/1.1 204 No Content

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "The requested item does not exist or access denied."
}

DELETE /fd-api/v1/ems-cases/:ems_case_id/ems-case-snapshots/:id

Delete EMS case snapshot item.

DELETE /fd-api/v1/ems-cases/:ems_case_id/ems-case-snapshots/:id

Parameters

Example Requests

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X DELETE https://sizeup.firstduesizeup.com/fd-api/v1/ems-cases/111/ems-case-snapshots/111

Success Response

HTTP/1.1 204 No Content

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "The requested item does not exist or access denied."
}

POST /fd-api/v1/ems-cases/:ems_case_id/ems-case-snapshots/:ems_case_snapshot_id/ems-case-snapshot-images

Create a EMS case snapshot image.

POST /fd-api/v1/ems-cases/:ems_case_id/ems-case-snapshots/:ems_case_snapshot_id/ems-case-snapshot-images

Parameters

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X POST -d '{"pos": 1, "waveform_type": "WAVEFORM_TYPE", "image_base64": "data:image/png;..."}' https://sizeup.firstduesizeup.com/fd-api/v1/ems-cases/11/ems-case-snapshots/111/ems-case-snapshot-images

Success Response

HTTP/1.1 201 Created
{
  "id": 111
}

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

HTTP/1.1 409 Conflict
{
  "code": 0,
  "message": "Object already exists."
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": "Validation Failed. Please provide address parameter.",
  "errors": [
    {
      "field": "image_base64",
      "code": "missing_field",
      "message": "Please provide address parameter."
    }
  ]
}

PUT /fd-api/v1/ems-cases/:ems_case_id/ems-case-snapshots/:ems_case_snapshot_id/ems-case-snapshot-images/:id

Update EMS case snapshot image item completely.

PUT /fd-api/v1/ems-cases/:ems_case_id/ems-case-snapshots/:ems_case_snapshot_id/ems-case-snapshot-images/:id

Parameters

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X PUT -d '{"pos": 1, "waveform_type": "WAVEFORM_TYPE", "image_base64": "data:image/png;..."}' https://sizeup.firstduesizeup.com/fd-api/v1/ems-cases/111/ems-case-snapshots/111/ems-case-snapshot-images/111

Success Response

HTTP/1.1 204 No Content

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "The requested item does not exist or access denied."
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": "Validation Failed. Please provide address parameter.",
  "errors": [
    {
      "field": "image_base64",
      "code": "missing_field",
      "message": "Please provide address parameter."
    }
  ]
}

DELETE /fd-api/v1/ems-cases/:ems_case_id/ems-case-snapshots/:ems_case_snapshot_id/ems-case-snapshot-images/:id

Delete EMS case snapshot item.

DELETE /fd-api/v1/ems-cases/:ems_case_id/ems-case-snapshots/:ems_case_snapshot_id/ems-case-snapshot-images/:id

Parameters

Example Requests

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X DELETE https://sizeup.firstduesizeup.com/fd-api/v1/ems-cases/111/ems-case-snapshots/111/ems-case-snapshot-images/111

Success Response

HTTP/1.1 204 No Content

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "The requested item does not exist or access denied."
}

GET /fd-api/v1/ems-cases/:ems_case_id/ems-case-twelve-leads

Get EMS case twelve leads.

GET /fd-api/v1/ems-cases/:ems_case_id/ems-case-twelve-leads

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -G --data-urlencode "since=2019-02-15T19:00:00+00:00" https://sizeup.firstduesizeup.com/fd-api/v1/ems-cases/111/ems-case-twelve-leads

Success Response

HTTP/1.1 200 OK
[
  {
    "id": 123,
    "adjusted_at": "2022-02-16T19:42:00+00:00",
  },
  {
    ...
  }
]

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

POST /fd-api/v1/ems-cases/:ems_case_id/ems-case-twelve-leads

Create a EMS case twelve lead.

POST /fd-api/v1/ems-cases/:ems_case_id/ems-case-twelve-leads

Parameters

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X POST -d '{"image_base64": "data:image/png;..."}' https://sizeup.firstduesizeup.com/fd-api/v1/ems-cases/111/ems-case-twelve-leads

Success Response

HTTP/1.1 201 Created
{
  "id": 111
}

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

HTTP/1.1 409 Conflict
{
  "code": 0,
  "message": "Object already exists."
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": "Validation Failed. Please provide address parameter.",
  "errors": [
    {
      "field": "image_base64",
      "code": "missing_field",
      "message": "Please provide address parameter."
    }
  ]
}

PUT /fd-api/v1/ems-cases/:ems_case_id/ems-case-twelve-leads/:id

Update EMS case twelve lead item completely.

PUT /fd-api/v1/ems-cases/:ems_case_id/ems-case-twelve-leads/:id

Parameters

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X PUT -d '{"image_base64": "data:image/png;..."}' https://sizeup.firstduesizeup.com/fd-api/v1/ems-cases/111/ems-case-twelve-leads/111

Success Response

HTTP/1.1 204 No Content

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "The requested item does not exist or access denied."
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": "Validation Failed. Please provide address parameter.",
  "errors": [
    {
      "field": "image_base64",
      "code": "missing_field",
      "message": "Please provide address parameter."
    }
  ]
}

DELETE /fd-api/v1/ems-cases/:ems_case_id/ems-case-twelve-leads/:id

Delete EMS case twelve lead item.

DELETE /fd-api/v1/ems-cases/:ems_case_id/ems-case-twelve-leads/:id

Parameters

Example Requests

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X DELETE https://sizeup.firstduesizeup.com/fd-api/v1/ems-cases/111/ems-case-twelve-leads/111

Success Response

HTTP/1.1 204 No Content

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "The requested item does not exist or access denied."
}

GET /fd-api/v1/ems-cases/:ems_case_id/ems-case-three-leads

Get EMS case three leads.

GET /fd-api/v1/ems-cases/:ems_case_id/ems-case-three-leads

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -G --data-urlencode "since=2025-01-10T19:00:00+00:00" https://sizeup.firstduesizeup.com/fd-api/v1/ems-cases/111/ems-case-three-leads

Success Response

HTTP/1.1 200 OK
[
  {
    "id": 123,
    "started_at": "2025-01-10T19:42:00+00:00",
  },
  {
    ...
  }
]

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

POST /fd-api/v1/ems-cases/:ems_case_id/ems-case-three-leads

Create a EMS case three lead.

POST /fd-api/v1/ems-cases/:ems_case_id/ems-case-three-leads

Parameters

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X POST -d '{"image_base64": "data:image/png;..."}' https://sizeup.firstduesizeup.com/fd-api/v1/ems-cases/111/ems-case-three-leads

Success Response

HTTP/1.1 201 Created
{
  "id": 111
}

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

HTTP/1.1 409 Conflict
{
  "code": 0,
  "message": "Object already exists."
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": "Validation Failed. Please provide address parameter.",
  "errors": [
    {
      "field": "image_base64",
      "code": "missing_field",
      "message": "Please provide address parameter."
    }
  ]
}

PUT /fd-api/v1/ems-cases/:ems_case_id/ems-case-three-leads/:id

Update EMS case three lead item completely.

PUT /fd-api/v1/ems-cases/:ems_case_id/ems-case-three-leads/:id

Parameters

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X PUT -d '{"image_base64": "data:image/png;..."}' https://sizeup.firstduesizeup.com/fd-api/v1/ems-cases/111/ems-case-three-leads/111

Success Response

HTTP/1.1 204 No Content

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "The requested item does not exist or access denied."
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": "Validation Failed. Please provide address parameter.",
  "errors": [
    {
      "field": "image_base64",
      "code": "missing_field",
      "message": "Please provide address parameter."
    }
  ]
}

DELETE /fd-api/v1/ems-cases/:ems_case_id/ems-case-three-leads/:id

Delete EMS case three lead item.

DELETE /fd-api/v1/ems-cases/:ems_case_id/ems-case-three-leads/:id

Parameters

Example Requests

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X DELETE https://sizeup.firstduesizeup.com/fd-api/v1/ems-cases/111/ems-case-three-leads/111

Success Response

HTTP/1.1 204 No Content

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "The requested item does not exist or access denied."
}

GET /fd-api/v1/ems-cases/:ems_case_id/ems-case-treatment-marker

Get EMS case treatment marker.

GET /fd-api/v1/ems-cases/:ems_case_id/ems-case-treatment-marker

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" https://sizeup.firstduesizeup.com/fd-api/v1/ems-cases/111/ems-case-treatment-marker

Success Response

HTTP/1.1 200 OK
[
  {
    "id": 123,
    "recorded_at": "2024-05-15T19:00:00+00:00",
    "code": "Code Treatment Marker",
    "name": "Name Treatment Marker",
  },
  {
    ...
  }
]

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

POST /fd-api/v1/ems-cases/:ems_case_id/ems-case-treatment-marker

Create a EMS case treatment marker.

POST /fd-api/v1/ems-cases/:ems_case_id/ems-case-treatment-marker

Parameters

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X POST -d '{"recorded_at": "2024-05-15T13:15:59Z", "code": "CODE", "name": "NAME"}' https://sizeup.firstduesizeup.com/fd-api/v1/ems-cases/111/ems-case-treatment-marker

Success Response

HTTP/1.1 201 Created
{
  "id": 111
}

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

HTTP/1.1 409 Conflict
{
  "code": 0,
  "message": "Object already exists."
}

PUT /fd-api/v1/ems-cases/:ems_case_id/ems-case-treatment-marker/:id

Update EMS case treatment marker item completely.

PUT /fd-api/v1/ems-cases/:ems_case_id/ems-case-treatment-marker/:id

Parameters

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X PUT -d '{"recorded_at": "2024-05-15T13:15:59Z", "code": "CODE", "name": "NAME"}' https://sizeup.firstduesizeup.com/fd-api/v1/ems-cases/111/ems-case-treatment-marker/111

Success Response

HTTP/1.1 204 No Content

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "The requested item does not exist or access denied."
}

DELETE /fd-api/v1/ems-cases/:ems_case_id/ems-case-treatment-marker/:id

Delete EMS case treatment marker item.

DELETE /fd-api/v1/ems-cases/:ems_case_id/ems-case-treatment-marker/:id

Parameters

Example Requests

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X DELETE https://sizeup.firstduesizeup.com/fd-api/v1/ems-cases/111/ems-case-treatment-marker/111

Success Response

HTTP/1.1 204 No Content

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "The requested item does not exist or access denied."
}

GET /fd-api/v1/ems-cases/:ems_case_id/ems-case-medication-marker

Get EMS case medication marker.

GET /fd-api/v1/ems-cases/:ems_case_id/ems-case-medication-marker

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" https://sizeup.firstduesizeup.com/fd-api/v1/ems-cases/111/ems-case-medication-marker

Success Response

HTTP/1.1 200 OK
[
  {
    "id": 123,
    "recorded_at": "2024-05-15T19:00:00+00:00",
    "code": "Code Medication Marker",
    "name": "Name Medication Marker",
  },
  {
    ...
  }
]

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

POST /fd-api/v1/ems-cases/:ems_case_id/ems-case-medication-marker

Create a EMS case medication marker.

POST /fd-api/v1/ems-cases/:ems_case_id/ems-case-medication-marker

Parameters

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X POST -d '{"recorded_at": "2024-05-15T13:15:59Z", "code": "CODE", "name": "NAME", "dosage": "DOSAGE", "dosage_unit": "DOSAGE_UNIT", "route": "ROUTE", "volume": "VOLUME", "volume_unit": "VOLUME_UNIT"}' https://sizeup.firstduesizeup.com/fd-api/v1/ems-cases/111/ems-case-medication-marker

Success Response

HTTP/1.1 201 Created
{
  "id": 111
}

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

HTTP/1.1 409 Conflict
{
  "code": 0,
  "message": "Object already exists."
}

PUT /fd-api/v1/ems-cases/:ems_case_id/ems-case-medication-marker/:id

Update EMS case medication marker item completely.

PUT /fd-api/v1/ems-cases/:ems_case_id/ems-case-medication-marker/:id

Parameters

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X PUT -d '{"recorded_at": "2024-05-15T13:15:59Z", "code": "CODE", "name": "NAME", "dosage": "DOSAGE", "dosage_unit": "DOSAGE_UNIT", "route": "ROUTE", "volume": "VOLUME", "volume_unit": "VOLUME_UNIT"}' https://sizeup.firstduesizeup.com/fd-api/v1/ems-cases/111/ems-case-medication-marker/111

Success Response

HTTP/1.1 204 No Content

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "The requested item does not exist or access denied."
}

DELETE /fd-api/v1/ems-cases/:ems_case_id/ems-case-medication-marker/:id

Delete EMS case medication marker item.

DELETE /fd-api/v1/ems-cases/:ems_case_id/ems-case-medication-marker/:id

Parameters

Example Requests

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X DELETE https://sizeup.firstduesizeup.com/fd-api/v1/ems-cases/111/ems-case-medication-marker/111

Success Response

HTTP/1.1 204 No Content

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "The requested item does not exist or access denied."
}

GET /fd-api/v1/aladtec-personnel

Get aladtec personnel.

GET /fd-api/v1/aladtec-personnel

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" https://sizeup.firstduesizeup.com/fd-api/v1/aladtec-personnel

Success Response

HTTP/1.1 200 OK

[
  {
    "id": 123,
    "agency_id": "AG87654323",
    "name": "NAME"
    "staffing_calendar_date": "2015-12-29T13:15:59+00:00",
    "staffing_start_date: "2015-12-29T15:15:59+00:00",
    "staffing_end_date": "2015-12-29T15:15:59+00:00",
    "is_working": true,
    "unit_call_sign": "UNIT3",
  },
  {
    ...
  }
]

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

POST /fd-api/v1/aladtec-personnel

Create a aladtec personnel.

POST /fd-api/v1/aladtec-personnel

Parameters

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X POST -d '{"agency_id": "AG87654323", "name": "TEST NAME", "staffing_calendar_date": "2015-12-29T13:15:59Z", "staffing_start_date": "2015-12-29T15:15:59Z", "staffing_end_date": "2015-12-29T17:15:59Z", "is_working" : false, "unit_call_sign" : "UNIT3"}' https://sizeup.firstduesizeup.com/fd-api/v1/aladtec-personnel

Success Response

HTTP/1.1 204 No Content

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

HTTP/1.1 409 Conflict
{
  "code": 0,
  "message": "Object already exists."
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": "Validation Failed. Please provide agency_id parameter.",
  "errors": [
    {
      "field": "agency_id",
      "code": "missing_field",
      "message": "Please provide agency_id parameter."
    }
  ]
}

PUT /fd-api/v1/aladtec-personnel/:id

Update aladtec personnel item completely.

PUT /fd-api/v1/aladtec-personnel/:id

Parameters

Example Requests

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X PUT -d '{"agency_id": "AG87654323", "name": "TEST NAME", "staffing_calendar_date": "2015-12-29T13:15:59Z", "staffing_start_date": "2015-12-29T15:15:59Z", "staffing_end_date": "2015-12-29T17:15:59Z", "is_working" : false, "unit_call_sign" : "UNIT3"}' https://sizeup.firstduesizeup.com/fd-api/v1/aladtec-personnel/3

Success Response

HTTP/1.1 204 No Content

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "The requested item does not exist or access denied."
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": "Validation Failed. Please provide agency_id parameter.",
  "errors": [
    {
      "field": "agency_id",
      "code": "missing_field",
      "message": "Please provide agency_id parameter."
    }
  ]
}

DELETE /fd-api/v1/aladtec-personnel/:id

Delete aladtec personnel item.

DELETE /fd-api/v1/aladtec-personnel/:id

Parameters

Example Requests

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X DELETE https://sizeup.firstduesizeup.com/fd-api/v1/aladtec-personnel/3

Success Response

HTTP/1.1 204 No Content

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "The requested item does not exist or access denied."
}

GET /fd-api/v1/dispatch-units/codes

Get dispatch unit codes.

GET /fd-api/v1/dispatch-units/codes

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" https://sizeup.firstduesizeup.com/fd-api/v1/dispatch-units/codes

Success Response

HTTP/1.1 200 OK
['CODE1', 'CODE2', 'CODE3']

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

GET /fd-api/v1/fire-incidents/

Get Fire Incident information. Request will be paginated to 500 items by default.

GET /fd-api/v1/fire-incidents

Parameters

Example Requests

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" https://sizeup.firstduesizeup.com/fd-api/v1/fire-incidents?status_codes=incomplete,authorized&start_alarm_at=2023-6-10T13:15:59Z&end_alarm_at=2023-6-10T17:15:59Z

Success Response

HTTP/1.1 200 OK

[
  fire_incidents: [
    {
      "incident_number": "1234565",
      "status_code": "incompleted",
      "actual_incident_type": "100",
      "aid_type": "1",
      "alarm_at": "2022-11-14T19:42:00+00:00",
      "created_at": "2022-11-14T19:42:00+00:00",
      "updated_at": "2022-11-14T19:42:00+00:00",
      "dispatch_type_code": "TYP001",
      "dispatch_comment": "comment",
      "dispatch_notified_at": "2022-11-14T19:42:00+00:00",
      "alarms": 3,
      "water_on_fire_at": "2022-11-14T19:42:00+00:00",
      "rit_established_at": "2022-11-14T19:42:00+00:00",
      "rehab_established_discontinued_at": "2022-11-14T19:42:00+00:00",
      "control_utility_at": "2022-11-14T19:42:00+00:00",
      "command_established_at": "2022-11-14T19:42:00+00:00",
      "primary_search_complete_at": "2022-11-14T19:42:00+00:00",
      "loss_stopped_at": "2022-11-14T19:42:00+00:00",
      "action_takens": ["15", "21", "44"]
      "property_loss": 1,
      "contents_loss": 1,
      "pre_incident_property_value": 1,
      "pre_incident_contents_value": 1,
      "department_narratives": [
        {
          "edited_by": "User",
          "edited_at": "2022-11-14T19:42:00+00:00",
          "narrative": "Narrative"
        }
      ],
      "latitude": 47.633523,
      "longitude": -122.277157,
      "address": "ADDRESS",
      "suite": "",
      "city": null,
      "state": null,
      "zip_code": "12345",
      "first_due": "A3",
      "battalion": "Gig Harbor (WA) FD",
      "response_zone": Zone 1,
      "apparatuses": [
        {
          "unit_id": "AP1000",
          "primary_use_code": "1",
          "is_primary": false,
          "dispatch_at": "2022-11-14T19:42:00+00:00",
          "enroute_at": "2022-11-14T19:42:00+00:00",
          "arrived_at": "2022-11-14T19:42:00+00:00",
          "cleared_at": "2022-11-14T19:42:00+00:00",
          "personnels": [
            {
              "first_name": "Jane",
              "last_name": "Dog",
              "agency_id": "AG111",
              "rank": "Firefighter"
            }
          ]
        }
      ]
    },
    {
      ...
    }
  ],
total: 500
pages: 1
]

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": "Validation Failed. Please provide a valid status_codes parameter.",
  "errors": [
    {
      "field": "status_codes",
      "code": "invalid",
      "message": "The status_codes: S1, S2 are not valid."
    }
  ]
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": "Validation Failed. Please provide a valid start_alarm_at parameter.",
  "errors": [
    {
      "field": "start_alarm_at",
      "code": "invalid",
      "message": "Please provide a date in ISO 8601 format."
    }
  ]
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": "Validation Failed. Please provide a valid end_alarm_at parameter.",
  "errors": [
    {
      "field": "end_alarm_at",
      "code": "invalid",
      "message": "Please provide a date in ISO 8601 format."
    }
  ]
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": "Validation Failed. Please provide a valid start_update_at parameter.",
  "errors": [
    {
      "field": "start_updated_at",
      "code": "invalid",
      "message": "Please provide a date in ISO 8601 format."
    }
  ]
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": "Validation Failed. Please provide a valid end_updated_at parameter.",
  "errors": [
    {
      "field": "end_updated_at",
      "code": "invalid",
      "message": "Please provide a date in ISO 8601 format."
    }
  ]
}

GET /fd-api/v1/device-locations

Get device locations.

GET /fd-api/v1/device-locations

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" https://sizeup.firstduesizeup.com/fd-api/v1/device-locations

Success Response

HTTP/1.1 200 OK
[
  {
    "id": 1,
    "name": "Public Name (Device #1)",
    "type": "Fire Department Engine",
    "latitude": "40.0000000",
    "longitude": "-120.0000000",
    "status_code": "active",
    "updated_at": "2017-12-15T10:42:00+00:00",
    "responder_status": "On Station",
    "responder_status_code": "on_station",
    "responding_address": "55155",
    "responding_dispatch_place_location": "55155 ROBERT STREET , 55155",
    "fire_station_id": 113,
    "fire_station_name_or_number": "Firehouse No. 4 (Sacramento, California)"
  },
  ...
]

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

GET /fd-api/v1/invoice/:occupancy_id

Get occupancy invoices pending to be paid.

GET /fd-api/v1/invoice/:occupancy_id

Example Request

$ curl -i -k https://sizeup.firstduesizeup.com/fd-api/v1/invoice/12456

Success Response

HTTP/1.1 200 OK
[
  {
    "status": "UnPaid",
    "amount": "105.00",
    "dueDate": "2024/03/01",
    "externalReferenceNumber": "912f1663-3e4d-4204-bef7-fd8ee253f13e",
    "invoice_number": "ARL-INV-2024-0000068",
    "occupancy_id": "12456",
  },
  ...
]

Error Response

HTTP/1.1 422 Unprocessable entity
{
  "code": 0,
  "message": "Validation Failed. Please provide required parameters."
}

POST /fd-api/v1/paymentus/confirm-payment

Confirm Paymentus payment or refund.

POST /fd-api/v1/paymentus/confirm-payment

Parameters

Example Request

$ curl -i -k -X POST -d '<?xml version="1.0" encoding="UTF-8"?><payment><referenceNumber>89185561</referenceNumber><externalreferenceNumber>912f1663-3e4d-4204-bef7-fd8ee253f13e</externalreferenceNumber><paymentDate>02142024153110</paymentDate><status>ACCEPTED</status><amount>-150</amount></payment>' https://sizeup.firstduesizeup.com/fd-api/v1/paymentus/confirm-payment

Success Response

HTTP/1.1 200 OK

Error Response

HTTP/1.1 422 Unprocessable entity
{
  "code": 0,
  "message": "Invalid Request."
}

HTTP/1.1 404 Not Found
{
  "code": 0,
  "message": "Invoice not found for invoice reference number: 912f1663-3e4d-4204-bef7-fd8ee253f13e."
}

HTTP/1.1 409 Conflict
{
  "code": 0,
  "message": "Payment already processed./Refund already processed."
}

POST /fd-api/v1/device-locations

Post the current user/unit location.

POST /fd-api/v1/device-locations

Parameters is an array of objects.

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X POST -d '[{"email": "DEVICE_USER_EMAIL", "device_id": "DEVICE_ID", "lat": 40.0, "lng": -120.0}]' https://sizeup.firstduesizeup.com/fd-api/v1/device-locations

Success Response

HTTP/1.1 200 OK
[
  {
    "success": true,
    "errors": []
  },
  {
    "success": false,
    "errors": ["Please provide email parameter."]
  }
]

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": Validation Failed. Empty parameters.",
  "errors": []
}

GET /fd-api/v1/occupancies

Get occupancies. Request will be paginated to 20 items by default.

GET /fd-api/v1/occupancies

Parameters

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -G --data-urlencode  https://sizeup.firstduesizeup.com/fd-api/v1/occupancies

Success Response

HTTP/1.1 200 OK
[
  {
    "occupancy_id": 14930699,
    "parcel_number": "0809003435",
    "local_id": null,
    "external_occupancy_id": null,
    "address_1": "100 BOSTON ST",
    "address_2": null,
    "city": "SEATTLE",
    "state": "WA",
    "zip": "98109",
    "occupancy_address": "100 BOSTON ST, SEATTLE, WA, 98109",
    "street_name": "BOSTON",
    "status_code": "active",
    "business_name": "Moorman Properties"
  },
  {
    ...
  }
]

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

GET /fd-api/v1/_health

Get Stryker API health. Executes a basic health check of the service and provides the status.

GET /fd-api/v1/_health

Example Request

$ curl -i -k -H "x-api-key: 4cc212aac77dad9f9e1e5e2b2be5dd5a" https://sizeup.firstduesizeup.com/fd-api/v1/_health

Success Response

HTTP/1.1 200 OK
"OK - The service is healthy."

Error Response

HTTP/1.1 401 Unauthorized
"Unauthorized - The requester is not authenticated. This status may indicate that authentication credentials are invalid, malformed, or not provided. There is no need to retry the request because interface violations require changes on the client side, and invalid credentials are unlikely to become valid."

HTTP/1.1 500 Internal Server Error
"Internal Server Error - An unexpected error has occurred in the service while processing the request. It is recommended to retry the request 30 seconds later but not to execute more than 3 retries. Refer to the response content for more details regarding the error that occurred."

HTTP/1.1 503 Service Unavailable
"Service Unavailable - The service is temporarily unavailable due to maintenance or other reasons. It is recommended to retry the request one minute later."

GET /fd-api/v1/_health/deep

Get Stryker API health. Executes an advanced health check of the service and provides the status.

GET /fd-api/v1/_health/deep

Example Request

$ curl -i -k -H "x-api-key: 4cc212aac77dad9f9e1e5e2b2be5dd5a" https://sizeup.firstduesizeup.com/fd-api/v1/_health/deep

Success Response

HTTP/1.1 200 OK
"OK - The service is healthy."

Error Response

HTTP/1.1 401 Unauthorized
"Unauthorized - The requester is not authenticated. This status may indicate that authentication credentials are invalid, malformed, or not provided. There is no need to retry the request because interface violations require changes on the client side, and invalid credentials are unlikely to become valid."

HTTP/1.1 500 Internal Server Error
"Internal Server Error - An unexpected error has occurred in the service while processing the request. It is recommended to retry the request 30 seconds later but not to execute more than 3 retries. Refer to the response content for more details regarding the error that occurred."

HTTP/1.1 503 Service Unavailable
"Service Unavailable - The service is temporarily unavailable due to maintenance or other reasons. It is recommended to retry the request one minute later."

PUT /fd-api/v1/patientRecords/:recordId

Upload patient record to Stryker API. Uploads a patient record.

PUT /fd-api/v1/patientRecords/:recordId

Parameters

Example Request

$ curl -i -k -H "x-api-key: 4cc212aac77dad9f9e1e5e2b2be5dd5a" https://sizeup.firstduesizeup.com/fd-api/v1/patientRecords/db9b692f-f57b-4d56-8501-82f6a9763ef8

Success Response

HTTP/1.1 200 OK
"OK - The patient record has been uploaded successfully."

Error Response

HTTP/1.1 400 Bad request
"Bad Request - The request is invalid or malformed. For example, some data is missing, or the data format is invalid. This includes issues with a request body and problems with request headers. Usually, this status indicates the wrong interface implementation on the client side. There is no need to retry the request because interface violations require changes on the client or service sides. Refer to the response content for more details regarding the interface violation."

HTTP/1.1 401 Unauthorized
"Unauthorized - The requester is not authenticated. This status may indicate that authentication credentials are invalid, malformed, or not provided. There is no need to retry the request because interface violations require changes on the client side, and invalid credentials are unlikely to become valid."

HTTP/1.1 500 Internal Server Error
"Internal Server Error - An unexpected error has occurred in the service while processing the request. It is recommended to retry the request 30 seconds later but not to execute more than 3 retries. Refer to the response content for more details regarding the error that occurred."

HTTP/1.1 503 Service Unavailable
"Service Unavailable - The service is temporarily unavailable due to maintenance or other reasons. It is recommended to retry the request one minute later."

GET /fd-api/v1/ems-zoll-configs

Get all EMS Zoll configurations.

GET /fd-api/v1/ems-zoll-configs

Description

Returns all Zoll configurations from the ems_zoll_config table. Each configuration includes: - Client-specific data (client_code, data_access_key, password) - Common Zoll connector settings (url, license, localPath) from epcrZollConnector configuration - Generated local paths for Incoming and Imported folders

Note: If the common Zoll connector configuration (epcrZollConnector) is not properly configured in the system, this endpoint will return an empty array.

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" https://sizeup.firstduesizeup.com/fd-api/v1/ems-zoll-configs

Success Response

HTTP/1.1 200 OK
[
  {
    "id": 1,
    "client_code": "CLIENT_CODE1",
    "data_access_key": "DATA_ACCESS_KEY1",
    "password": "PASSWORD1",
    "url": "https://boundarysvc.zollonline.com/GemstoneWebAPI/",
    "license": "LICENSE_KEY",
    "local_path_incoming": "C:\\FDSU\\Connector\\CLIENT_CODE1\\Incoming",
    "local_path_imported": "C:\\FDSU\\Connector\\CLIENT_CODE1\\Imported"
  },
  {
    "id": 2,
    "client_code": "CLIENT_CODE2",
    "data_access_key": "DATA_ACCESS_KEY2",
    "password": "PASSWORD2",
    "url": "https://boundarysvc.zollonline.com/GemstoneWebAPI/",
    "license": "LICENSE_KEY",
    "local_path_incoming": "C:\\FDSU\\Connector\\CLIENT_CODE2\\Incoming",
    "local_path_imported": "C:\\FDSU\\Connector\\CLIENT_CODE2\\Imported"
  }
]

Response Fields

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

Notes

• The endpoint returns an empty array [] if the common Zoll connector configuration is not properly set up in the system configuration file.
• Sensitive fields (data_access_key, password) are returned as stored values from the database.
• Local paths are generated using Windows path separators (\) by concatenating the common localPath with the client_code and folder names (Incoming or Imported).

GET /fd-api/v1/get-hydrants

Get hydrants. Request will be return a hydrant or hydrant that match with the parameters.

GET /fd-api/v1/get-hydrants

Parameters

Date parameters are in ISO 8601 in formatted datetime (YYYY-MM-DDTHH:MM:SS:Z).

When missing_hydrant_id=false or omitted, return all hydrants without this filter. | | missing_facility_code | string | When missing_facility_code=true, return only hydrants with a missing Facility Code. When missing_facility_code=false or omitted, return all hydrants without this filter. | | updated_after | string | Only hydrants updated at or after this time are returned. This is a timestamp in ISO 8601 format. | | page | int | Number of pages | | limit | int | Display per page records |

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -G --data-urlencode "service_date_to=2019-02-15T19:00:00+00:00" "assigned_to_user=1" "facility_code=53/8" https://sizeup.firstduesizeup.test/fd-api/v1/get-hydrants

Success Response

HTTP/1.1 200 OK
{
  "current_page": 1,
  "total_pages": 1,
  "total_hydrant_records": 22,
  "total_hydrants_per_page": 22,
  "has_more": false,
  "items": [
    {
      "facility_code": "53/8",
      "id": 430945,
      "client_code": "THOMASVILLE",
      "hydrant_type_code": "HYDRANT",
      "year": null,
      "fort_lauderdale_owner_code": null,
      "latitude": "40.3499156",
      "longitude": "-75.9365641",
      "hydrant_status_code": "In service",
      "inspected_at": "2024-10-28T14:02:00+00:00",
      "area_ids_cache": "{5546}",
      "static_pressure": "123.00",
      "residual_pressure": "123.00",
      "residual_flow_rate": "123.00",
      "hydrant_type_name": "Hydrant",
      "address": null,
      "apparatus": null,
      "closest_address": null,
      "fire_zone": null,
      "inspected_by": "User #8377",
      "hydrant_zone": null,
      "xref_id": null,
      "base_color_code": "Class C Red less than 500 gpm - white outline",
      "manufacturer": "1997",
      "num_outlet": 3,
      "steamer_port": "4.5\"",
      "outlet_size2": "2.5\"",
      "outlet_size3": "2.5\"",
      "source": null,
      "location": "In front of 932 McKnight Street",
      "cistern_capacity_gallons": null,
      "main_size": null,
      "barrel_size": null,
      "last_flow_tested_at": "04/25/2024 09:45",
      "water_department": "RAWA",
      "model": null,
      "notes": null,
      "is_private": false,
      "cistern_capacity_liters": null,
      "calculated_flow_rate": "120.00",
      "fire_district": null,
      "valve_location": null,
      "placement": null,
      "fire_station": null,
      "shift": null,
      "assigned_user": null,
      "annual_maintenance": null,
      "reason_out_of_service": null,
      "hydrant_type_bg_color": null,
      "icon_file_path": null,
      "agency_name": "Thomasville",
      "flow_hydrant_one": "First Due ID: 566213",
      "flow_hydrant_two": "First Due ID: 566233",
      "pitot_gauge_one": 3,
      "pitot_gauge_two": 3,
      "team_id": 32,
      "assigned_team": "Team 3",
      "responsible_occupancy": null,
      "pressure_zone": null,
      "created_at": "2025-06-02T16:48:35+00:00",
      "updated_at": "2026-03-18T15:00:18+00:00",
      "flowed_by": "User #8377",
    },
    {
      ...
    }
  ]
}

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": "Please provide valid parameters like (id, facility_code, hydrant_status_code, hydrant_type_code, fire_zone_id, shift_id, assigned_to_user, assigned_to_team, service_date_to, service_date_from, flow_date_to, flow_date_from)",
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": "Please provide a valid parameter.",
  "errors": [
    {
      "field": "service_date_from",
      "code": "invalid",
      "message": "Invalid service date from parameter."
    },
    {
        "code": "invalid",
        "field": "updated_after",
        "message": "Invalid updated after parameter (use: YYYY-MM-DDTHH:MM:SSZ format)."
    }
  ]
}

GET /fd-api/v1/get-hydrant-services

Get hydrant services. Request will be return a hydrant service or services that match with the parameters.

GET /fd-api/v1/get-hydrant-services

Parameters

Date parameters are in ISO 8601 in formatted datetime (YYYY-MM-DDTHH:MM:SS:Z).

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -G --data-urlencode "completed_at_from=2025-04-20T14:35:00Z" "most_recent=1" "facility_code=53/8" https://sizeup.firstduesizeup.test/fd-api/v1/get-hydrant-services

Success Response

HTTP/1.1 200 OK
[
  {
    "completed_date": "2024-10-23T21:54:55+00:00",
    "firstdue_id": 430945,
    "facility_id": "53/8",
    "hydrant_id": null,
    "hydrant_type_name": "Hydrant",
    "checklist_name": "Checklist Test",
    "activity_date": null,
    "questions": [
        {
            "question": "[Checklist 1] Is good?",
            "answer": "Test 1; Test 2; Test 3",
            "remark": null
        },
        {
            "question": "[Checklist 3] Color",
            "answer": "Brown",
            "remark": "Check A1"
        },
        {
            "question": "[Checklist 3] Hydrant Type",
            "answer": "Hydrant",
            "remark": "Check A3"
        },
        {
            "question": "[Checklist 3] Static Pressure",
            "answer": "2234",
            "remark": null
        },
        {
            "question": "[checklist 4] residual Pressure",
            "answer": "34543",
            "remark": null
        },
        {
            "question": "[checklist 4] Calculated Flow",
            "answer": "345",
            "remark": null
        },
        {
            "question": "[checklist 4] Flow hydrant",
            "answer": "345",
            "remark": null
        },
        {
            "question": "[checklist 4] Pass and fail 4",
            "answer": "Fail",
            "remark": null
        }
    ]
  },
  {
    ...
  }
]

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": "Please provide valid parameters like (firstdue_id, facility_code, hydrant_id, most_recent, completed_at_from, completed_at_to)",
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": "Please provide a valid parameter.",
  "errors": [
    {
      "field": "completed_at_from",
      "code": "invalid",
      "message": "Invalid completed date from parameter."
    }
  ]
}

GET /fd-api/v1/get-hydrant-flow-tests

Get hydrant flow tests. Request will be return a hydrant flow test or flow tests that match with the parameters.

GET /fd-api/v1/get-hydrant-flow-tests

Parameters

Date parameters are in ISO 8601 in formatted datetime (YYYY-MM-DDTHH:MM:SS:Z).

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -G --data-urlencode "completed_at_to=2019-02-15T19:00:00+00:00" "facility_code=53/8" https://sizeup.firstduesizeup.test/fd-api/v1/get-hydrant-flow-tests

Success Response

HTTP/1.1 200 OK
[
  {
    "firstdue_id": 430945,
    "facility_id": "53/8",
    "hydrant_id": null,
    "nearest_address": null,
    "flow_test_number": "TF-2025-0000001",
    "completed_date": "2025-01-06T22:45:43+00:00",
    "flow_tested_at": "2025-01-06T15:44:00+00:00",
    "static_pressure": "2.00",
    "maximum_test_residual_pressure": "1.00",
    "residual_pressure": "1.00",
    "drop": 1,
    "differential": 50,
    "flow_rates": {
        "twenty": 0,
        "ten": 0,
        "zero": 1489
    },
    "hydrant_flows": [
        {
            "id": 26,
            "hydrant_id": 430945,
            "discharges": [
                {
                    "flow": "787.3",
                    "coefficient": 0.9,
                    "outlet_size": 2.5,
                    "pitot_gauge": "22"
                },
                {
                    "flow": "237.4",
                    "coefficient": 0.9,
                    "outlet_size": 2.5,
                    "pitot_gauge": "2"
                }
            ],
            "facility_id": "53/8",
            "nearest_address": null,
            "total_flow": 1024.7
        }
    ],
    "department_members": "Camilo, First #10032 Last #10032, First #10094 Last #10094, First #10095 Last #10095, User #8377",
    "outside_agencies": null,
    "total_flow": 1024.7,
    "other_participants": null
  },
  {
    ...
  }
]

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": "Please provide valid parameters like (firstdue_id, facility_code, hydrant_id, most_recent, completed_at_from, completed_at_to)",
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": "Please provide a valid parameter.",
  "errors": [
    {
      "field": "completed_at_from",
      "code": "invalid",
      "message": "Invalid completed date from parameter."
    }
  ]
}

POST /fd-api/v1/set-hydrant-status

Set hydrant status.

POST /fd-api/v1/set-hydrant-status

Parameters

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X POST -d '{"hydrant_id": 12345, "status_code": "in_service"}' https://sizeup.firstduesizeup.com/fd-api/v1/set-hydrant-status

Success Response

HTTP/1.1 200 OK

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": 'hydrant_id parameter should not be empty'
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": 'Invalid hydrant id parameter'
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": 'Invalid status code parameter'
}

Success Response

HTTP/1.1 200 OK
{
  "total_open_count": 1,
  "items": [
    {
      "facility_code": null,
      "firstdue_id": 67,
      "client_code": "BROOKLYN_TEST",
      "hydrant_type_code": "HYDRANT",
      "year": 2024,
      "fort_lauderdale_owner_code": null,
      "latitude": "40.6967212",
      "longitude": "-73.9935332",
      "hydrant_status_code": "Out of service",
      "inspected_at": null,
      "area_ids_cache": "{1,911,964,976,1394,6965,8483,8801}",
      "static_pressure": null,
      "residual_pressure": null,
      "residual_flow_rate": null,
      "hydrant_type_name": "Hydrant",
      "address": null,
      "apparatus": null,
      "nearest_occupancy": null,
      "fire_zone": null,
      "inspected_by": null,
      "hydrant_zone": null,
      "hydrant_id": "8",
      "base_color_code": "",
      "manufacturer": "DT",
      "num_outlet": null,
      "steamer_port": null,
      "outlet_size2": null,
      "outlet_size3": null,
      "source": null,
      "location": null,
      "cistern_capacity_gallons": null,
      "main_size": null,
      "barrel_size": null,
      "last_flow_tested_at": null,
      "water_department": null,
      "model": null,
      "notes": null,
      "is_private": false,
      "cistern_capacity_liters": null,
      "calculated_flow_rate": null,
      "fire_district": null,
      "valve_location": null,
      "placement": null,
      "fire_station": null,
      "shift": null,
      "assigned_user": null,
      "annual_maintenance": null,
      "reason_out_of_service": null,
      "hydrant_type_bg_color": null,
      "icon_file_path": null,
      "agency_name": "Brooklyn Test",
      "flow_hydrant_one": null,
      "flow_hydrant_two": null,
      "pitot_gauge_one": null,
      "pitot_gauge_two": null,
      "team_id": null,
      "assigned_team": null,
      "responsible_occupancy": null,
      "pressure_zone": null,
      "flowed_by": ""
    }
  ]
}

HTTP/1.1 200 OK
{
  "total_open_count": 0,
  "items": []
}

POST /fd-api/v1/update-hydrant-work-order

Set hydrant status.

POST /fd-api/v1/update-hydrant-work-order

Parameters

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X POST -d '{"hydrant_id": 1051234, "work_order_number": 10, "eta_date": "2024-12-25T00:00:00+00:00", "work_performed": "test", "phase_id": 5}' https://sizeup.firstduesizeup.com/fd-api/v1/update-hydrant-work-order

Success Response

HTTP/1.1 200 OK

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": 'Please provide valid parameters'
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": "Please provide a valid parameter.",
  "errors": [
    {
      "field": "hydrant_id",
      "code": "invalid",
      "message": "Hydrant parameter is invalid"
    },
    {
      "field": "work_order_number",
      "code": "invalid",
      "message": "Work order number parameter is invalid"
    },
    {
      "field": "eta_date",
      "code": "invalid",
      "message": "Invalid eta date from parameter."
    }
  ]
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": 'Please provide valid work order phase parameters'
}

POST /fd-api/v1/create-hydrant-work-order

Set hydrant status.

POST /fd-api/create-hydrant-work-order

Parameters

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X POST -d '{"hydrant_id": 1051234, "eta_date": "2024-12-25T00:00:00+00:00", "work_performed": "test", "phase_id": 5, "type_id": 3, "submitted_by": 8377, "summary": "new test from fd_api"}' https://sizeup.firstduesizeup.com/fd-api/v1/create-hydrant-work-order

Success Response

HTTP/1.1 200 OK

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": 'Please provide required parameters (submitted_by, phase_id, type_id, hydrant_id, summary)'
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": "Please provide a valid parameter.",
  "errors": [
    {
      "field": "hydrant_id",
      "code": "invalid",
      "message": "Please provide valid hydrant parameters"
    },
    {
      "field": "phase_id",
      "code": "invalid",
      "message": "Please provide valid hydrant work order phase parameters"
    },
    {
      "field": "type_id",
      "code": "invalid",
      "message": "Please provide valid hydrant work order type parameters"
    },
    {
      "field": "submitted_by",
      "code": "invalid",
      "message": "Please provide valid submitted by parameters"
    },
    {
      "field": "eta_date",
      "code": "invalid",
      "message": "Invalid eta date from parameter."
    }
  ]
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": "Can`t create hydrant work order"
}

POST /fd-api/v1/create-hydrant

Create a new hydrant.

POST /fd-api/v1/create-hydrant

Parameters

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -H "Content-Type: application/json" -X POST -d '{"hydrant_type_code": "HYDRANT", "latitude": 40.7128, "longitude": -74.0060, "facility_code": "H001", "xref_id": "HYD-001", "address": "123 Main St"}' https://sizeup.firstduesizeup.com/fd-api/v1/create-hydrant

Success Response

HTTP/1.1 201 Created
{
  "facility_code": "HYD-PP22",
  "firstdue_id": 91,
  "client_code": "BROOKLYN_TEST",
  "hydrant_type_code": "HYDRANT",
  "year": null,
  "fort_lauderdale_owner_code": null,
  "latitude": "40.7128000",
  "longitude": "-73.4555000",
  "hydrant_status_code": null,
  "inspected_at": null,
  "area_ids_cache": "{1,55,148,227,259,309,901,964,985,2007,5575,8801}",
  "static_pressure": null,
  "residual_pressure": null,
  "residual_flow_rate": null,
  "hydrant_type_name": "Hydrant",
  "address": "54PPP Main Sttttt",
  "apparatus": null,
  "nearest_occupancy": null,
  "fire_zone": null,
  "inspected_by": null,
  "hydrant_zone": null,
  "hydrant_id": "HYD-PP22",
  "base_color_code": null,
  "manufacturer": null,
  "num_outlet": null,
  "steamer_port": null,
  "outlet_size2": null,
  "outlet_size3": null,
  "source": null,
  "location": null,
  "cistern_capacity_gallons": null,
  "main_size": null,
  "barrel_size": null,
  "last_flow_tested_at": null,
  "water_department": null,
  "model": null,
  "notes": null,
  "is_private": false,
  "cistern_capacity_liters": null,
  "calculated_flow_rate": null,
  "fire_district": null,
  "valve_location": null,
  "placement": null,
  "fire_station": null,
  "shift": null,
  "assigned_user": null,
  "annual_maintenance": null,
  "reason_out_of_service": null,
  "hydrant_type_bg_color": null,
  "icon_file_path": null,
  "agency_name": "Brooklyn Test",
  "flow_hydrant_one": null,
  "flow_hydrant_two": null,
  "pitot_gauge_one": null,
  "pitot_gauge_two": null,
  "team_id": null,
  "assigned_team": null,
  "responsible_occupancy": null,
  "pressure_zone": null,
  "flowed_by": ""
}

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": "Please provide valid parameters.",
  "errors": [
    {
      "field": "hydrant_type_code",
      "message": "Field hydrant_type_code is required"
    },
    {
      "field": "latitude",
      "message": "Field latitude is required"
    },
    {
      "field": "longitude",
      "message": "Field longitude is required"
    }
  ]
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": "Validation failed",
  "errors": [
    {
      "field": "hydrant_type_code",
      "message": "Type \"hydrant\" is invalid."
    }
  ]
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": "Validation failed",
  "errors": [
    {
      "field": "xref_id",
      "message": "Hydrant ID \"HYD-PP4AS\" has already been taken."
    }
  ]
}

PUT /fd-api/v1/update-hydrant?firstdue_id={firstdue_id}

PUT /fd-api/v1/update-hydrant?hydrant_id={hydrant_id}

PUT /fd-api/v1/update-hydrant?facility_code={facility_code}

Update an existing hydrant.

PUT /fd-api/v1/update-hydrant?... (Exactly one of firstdue_id, hydrant_id, facility_code must be provided as a query parameter)

Query Parameters (one required)

Parameters

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -H "Content-Type: application/json" -X PUT -d '{"facility_code": "H001-UPDATED", "hydrant_status_code": "in_service", "static_pressure": 65.5}' https://sizeup.firstduesizeup.com/fd-api/v1/update-hydrant?hydrant_id=HYD-PP22

Success Response

HTTP/1.1 200 OK
{
  "total_hydrant_records": 2,
  "items": [
    {
      "facility_code": "HYD-PP22",
      "firstdue_id": 102,
      "client_code": "BROOKLYN_TEST",
      "hydrant_type_code": "HYDRANT",
      "year": 2012,
      "fort_lauderdale_owner_code": null,
      "latitude": "40.7128000",
      "longitude": "-73.4555000",
      "hydrant_status_code": null,
      "inspected_at": null,
      "area_ids_cache": "{1,55,148,227,259,309,901,964,985,2007,5575,8801}",
      "static_pressure": null,
      "residual_pressure": null,
      "residual_flow_rate": null,
      "hydrant_type_name": "Hydrant",
      "address": "54PPP Main Sttttt",
      "apparatus": null,
      "nearest_occupancy": null,
      "fire_zone": null,
      "inspected_by": null,
      "hydrant_zone": null,
      "hydrant_id": "HYD-PP22",
      "base_color_code": null,
      "manufacturer": null,
      "num_outlet": null,
      "steamer_port": null,
      "outlet_size2": null,
      "outlet_size3": null,
      "source": null,
      "location": null,
      "cistern_capacity_gallons": null,
      "main_size": null,
      "barrel_size": null,
      "last_flow_tested_at": null,
      "water_department": null,
      "model": null,
      "notes": null,
      "is_private": false,
      "cistern_capacity_liters": null,
      "calculated_flow_rate": null,
      "fire_district": null,
      "valve_location": null,
      "placement": null,
      "fire_station": null,
      "shift": null,
      "assigned_user": null,
      "annual_maintenance": null,
      "reason_out_of_service": null,
      "hydrant_type_bg_color": null,
      "icon_file_path": null,
      "agency_name": "Brooklyn Test",
      "flow_hydrant_one": null,
      "flow_hydrant_two": null,
      "pitot_gauge_one": null,
      "pitot_gauge_two": null,
      "team_id": null,
      "assigned_team": null,
      "responsible_occupancy": null,
      "pressure_zone": null,
      "flowed_by": ""
    },
    {
      ----,
      ----
    },
  ]
}

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

HTTP/1.1 404 Not Found
{
  "code": 0,
  "message": "Hydrant not found"
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": "Please provide valid parameters.",
  "errors": [
    {
      "field": "hydrant_type_code",
      "message": "Field hydrant_type_code is required"
    },
    {
      "field": "latitude",
      "message": "Field latitude is required"
    }
  ]
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": "Validation failed",
  "errors": [
    {
      "field": "hydrant_type_code",
      "message": "Type \"hydrant\" is invalid."
    }
  ]
}

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": "Validation failed",
  "errors": [
    {
      "field": "xref_id",
      "message": "Hydrant ID \"HYD-PP4AS\" has already been taken."
    }
  ]
}

GET /fd-api/v1/fdids

Get a FDID list.

GET /fd-api/v1/fdids

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" https://sizeup.firstduesizeup.com/fd-api/v1/fdids

Success Response

HTTP/1.1 200 OK
{
  "list": [
    {
      "uuid": "4cee4bad-429d-465b-9c58-61d40fe728cf",
      "fdid": "09229",
      "name": "FDID1",
      "is_enabled": true,
      "is_default": false
    },
    {
      "uuid": "e1a10b81-ea5d-4b1a-8233-b84bed6a9f94",
      "fdid": "00122",
      "name": "FDID2",
      "is_enabled": true,
      "is_default": true
    }
  ],
  "total": 2
}

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

GET /fd-api/v1/stations

Get a Fire Station list.

GET /fd-api/v1/stations

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" https://sizeup.firstduesizeup.com/fd-api/v1/stations

Success Response

HTTP/1.1 200 OK
{
  "list": [
    {
        "uuid": "6db68f01-943d-442f-9a10-bad0fbb048cb",
        "name": "Station 1"
    },
    {
        "uuid": "7c66149f-9660-4649-baba-46b57060ac11",
        "name": "Station 2"
    }
  ],
  "total": 2
}

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

GET /fd-api/v1/shifts

Get a Battalion Department Shift list.

GET /fd-api/v1/shifts

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" https://sizeup.firstduesizeup.com/fd-api/v1/shifts

Success Response

HTTP/1.1 200 OK
{
  "list": [
    {
        "uuid": "ebe05dbe-185b-4ada-9e8f-de40f1d6f73a",
        "name": "Shift 1"
    },
    {
        "uuid": "7656306e-38be-44cf-ae22-e9b0647fc9ed",
        "name": "Shift 2"
    }
  ],
  "total": 2
}

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

GET /fd-api/v1/response-zones

Get a Battalion Department Response Zone list.

GET /fd-api/v1/response-zones

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" https://sizeup.firstduesizeup.com/fd-api/v1/response-zones

Success Response

HTTP/1.1 200 OK
{
  "list": [
    {
        "uuid": "4d2cd84a-ce18-4e85-92b6-c3df39347374",
        "name": "Response zone 1"
    },
    {
        "uuid": "4367f65c-9ca2-4993-957f-b382c7ec51fc",
        "name": "Response zone 2"
    }
  ],
  "total": 2
}

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

GET /fd-api/v1/aid-departments

Get a Battalion Department Aid list.

GET /fd-api/v1/aid-departments

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" https://sizeup.firstduesizeup.com/fd-api/v1/aid-departments

Success Response

HTTP/1.1 200 OK
{
  "list": [
    {
      "uuid": "1d5cbc85-34c1-4847-b439-37d2ff1d3d45",
      "fdid": "00122",
      "name": "Fire Department 1",
      "aid_type": "Manual"
    },
    {
      "uuid": "df8dd6d3-6fc6-42fe-96a4-c94a087caf38",
      "fdid": "01525",
      "name": "Fire Department 2",
      "aid_type": "Automatic"
    },
    {
      "uuid": "e1858558-05c0-4721-a384-2f005ff22233",
      "fdid": "88111",
      "name": "Fire Department 3",
      "aid_type": "Both"
    }
  ],
  "total": 3
}

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

GET /fd-api/v1/apparatuses

Get a Apparatus list.

GET /fd-api/v1/apparatuses

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" https://sizeup.firstduesizeup.com/fd-api/v1/apparatuses

Success Response

HTTP/1.1 200 OK
{
  "list": [
    {
      "uuid": "e9f3baf8-2880-4d82-9c7f-79e0ea4e20bc",
      "name": "Ambulance 1",
      "unit_code": "AMB1",
      "use_code": "2",
      "use_name": "EMS"
    },
    {
      "uuid": "f8813126-d976-41ff-81c0-adf8b3290d20",
      "name": "Ambulance 2",
      "unit_code": "AMB2",
      "use_code": "2",
      "use_name": "EMS"
    },
    {
      "uuid": "9824bc40-baa0-4c12-8aa7-3b930c194c93",
      "name": "Engine 1",
      "unit_code": "PE1",
      "use_code": "1",
      "use_name": "Suppression"
    }
  ],
  "total": 3
}

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

POST /fd-api/v1/apparatuses/operative-iq

Create a new apparatus for Operative IQ integration.

Required Permission: apiCreateApparatus

POST /fd-api/v1/apparatuses/operative-iq

Parameters

Important: - Fields marked as integer type must be numeric values (IDs from database tables). String values for these fields will be rejected with a validation error. - Fields marked as boolean type accept: true, false, "true", "false", 1, 0, "1", or "0".

Example Request

$ curl -i -k -H "Authorization: Bearer <YOUR_ACCESS_TOKEN>" -X POST -d '{
  "unit_id": "OIQ_001",
  "unit_number": "Engine 1",
  "unit_type": "ENGINE_STRUCT",
  "home_location": 50,
  "price": "850000.00",
  "purchase_date": "06/15/2020",
  "comments": "Primary engine for downtown area",
  "engine_tank_size": "750.00",
  "purchased_on_grant": true,
  "assigned_to": 1,
  "vom_eom": "Fire Engine",
  "vom_location": "Downtown Station",
  "county_id_number": "BAL001",
  "year": "01/01/2020",
  "make": "Pierce",
  "model": "Arrow XT",
  "vin": "1FDXE40S0YHA12345",
  "license_plate_number": "FD123",
  "title_number": 123456789,
  "home": 50,
  "current_location": 50,
  "cost_code": 357,
  "vehicle_number": "VH-001"
}' https://sizeup.firstduesizeup.com/fd-api/v1/apparatuses/operative-iq

Success Response

HTTP/1.1 201 Created
{
  "id": 1234,
  "name": "Engine 1",
  "api_apparatus_id": "OIQ_001",
  "created_at": "2025-09-26 14:30:00"
}

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

HTTP/1.1 422 Unprocessable entity
{
  "code": 0,
  "message": "Validation Failed. Please provide unit_number, vehicle_number parameters."
}

HTTP/1.1 422 Unprocessable entity
{
  "code": 0,
  "message": "Invalid data types for ID fields: assigned_to, cost_code. These fields must be numeric (integer IDs).",
  "errors": [
    {
      "field": "assigned_to",
      "code": "invalid_type",
      "message": "Field \"assigned_to\" must be a numeric ID (integer), not a string."
    },
    {
      "field": "cost_code",
      "code": "invalid_type",
      "message": "Field \"cost_code\" must be a numeric ID (integer), not a string."
    }
  ]
}

HTTP/1.1 422 Unprocessable entity
{
  "code": 0,
  "message": "Validation Failed. Invalid assigned_to value.",
  "errors": [
    {
      "field": "assigned_to",
      "code": "invalid_value",
      "message": "Field \"assigned_to\" must be a valid user ID for your organization."
    }
  ]
}

HTTP/1.1 422 Unprocessable entity
{
  "code": 0,
  "message": "Validation Failed. Invalid purchased_on_grant value.",
  "errors": [
    {
      "field": "purchased_on_grant",
      "code": "invalid_value",
      "message": "Field \"purchased_on_grant\" must be a valid boolean value: true, false, \"true\", \"false\", 1, 0, \"1\", or \"0\"."
    }
  ]
}

HTTP/1.1 422 Unprocessable entity
{
  "code": 0,
  "message": "Validation Failed. Body class length exceeds maximum.",
  "errors": [
    {
      "field": "body_class",
      "code": "max_length_exceeded",
      "message": "The combination of \"vom_eom\" and \"vom_location\" fields results in a body_class value that exceeds the maximum length of 64 characters. Current length: 85"
    }
  ]
}

PATCH /fd-api/v1/apparatuses/operative-iq/:id

Update an existing apparatus by ID for Operative IQ integration.

Required Permission: apiUpdateApparatusOperativeIQ

PATCH /fd-api/v1/apparatuses/operative-iq/:id

Parameters

Important: - Fields marked as integer type must be numeric values (IDs from database tables). String values for these fields will be rejected with a validation error. - Fields marked as boolean type accept: true, false, "true", "false", 1, 0, "1", or "0".

Example Request

$ curl -i -k -H "Authorization: Bearer <YOUR_ACCESS_TOKEN>" -X PATCH -d '{
  "unit_number": "Engine 1 Updated",
  "comments": "Updated primary engine for downtown area",
  "engine_tank_size": "800.00",
  "make": "Pierce",
  "model": "Arrow XT PUC",
  "current_location": 50
}' https://sizeup.firstduesizeup.com/fd-api/v1/apparatuses/operative-iq/1234

Success Response

HTTP/1.1 204 No Content

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

HTTP/1.1 404 Not Found
{
  "code": 0,
  "message": "Apparatus not found"
}

HTTP/1.1 422 Unprocessable entity
{
  "code": 0,
  "message": "Invalid values."
}

HTTP/1.1 422 Unprocessable entity
{
  "code": 0,
  "message": "Validation Failed. Invalid assigned_to value.",
  "errors": [
    {
      "field": "assigned_to",
      "code": "invalid_value",
      "message": "Field \"assigned_to\" must be a valid user ID for your organization."
    }
  ]
}

HTTP/1.1 422 Unprocessable entity
{
  "code": 0,
  "message": "Validation Failed. Invalid purchased_on_grant value.",
  "errors": [
    {
      "field": "purchased_on_grant",
      "code": "invalid_value",
      "message": "Field \"purchased_on_grant\" must be a valid boolean value: true, false, \"true\", \"false\", 1, 0, \"1\", or \"0\"."
    }
  ]
}

HTTP/1.1 422 Unprocessable entity
{
  "code": 0,
  "message": "Validation Failed. Body class length exceeds maximum.",
  "errors": [
    {
      "field": "body_class",
      "code": "max_length_exceeded",
      "message": "The combination of \"vom_eom\" and \"vom_location\" fields results in a body_class value that exceeds the maximum length of 64 characters. Current length: 85"
    }
  ]
}

GET /fd-api/v1/personnel

Get a Personnel list.

GET /fd-api/v1/personnel

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" https://sizeup.firstduesizeup.com/fd-api/v1/personnel

Success Response

HTTP/1.1 200 OK
{
  "list": [
    {
      "uuid": "4d2cd84a-ce18-4e85-92b6-c3df39347374",
      "full_name": "Jared A Barron",
      "first_name": "Jared",
      "middle_name": "A",
      "last_name": "Barron"
    },
    {
      "uuid": "c6d8cb63-13c5-4966-8a50-0742e0093af0",
      "full_name": "Gisela Weiss",
      "first_name": "Gisela",
      "middle_name": "",
      "last_name": "Weiss"
    }
  ],
  "total": 2
}

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

GET /fd-api/v1/personnel/list

Get a paginated list of personnel records with full details.

GET /fd-api/v1/personnel/list

Query Parameters

Pagination Rules: - page_size: Minimum value is 1. Maximum allowed value is 50. Requests with page_size > 50 will be automatically reduced to 50 by the server. When the server clamps page_size (e.g., request 100 → server reduces to 50), the response metadata will reflect the clamped value (page_size: 50). - page: Values ≤ 0 are normalized to 1 by the server. If page > total_pages (and total_pages > 0), the server returns an empty result set (data: []) with the requested page number preserved in the response metadata. - total_pages: Calculated as ceil(total_count / page_size) when total_count > 0, otherwise 0. No explicit upper limit; derived from total record count and page size.

Filter Parameters: - employment_status: Filters personnel records by their employment status code. Must match a valid status code value. Only personnel with matching status_code will be returned. - is_field_crew_service_provider: Filters personnel records by whether they are field crew service providers. Accepts various boolean representations (true/false, 1/0, "true"/"false", "yes"/"no", "on"/"off"). If not provided, this filter is not applied. - personnel_id: Filters personnel records by their ID. Accepts a comma-separated list of IDs. Maximum allowed count is 50. - first_due_id: Filters personnel records by their First Due ID. Accepts a comma-separated list of IDs. Maximum allowed count is 50.

Pagination

This endpoint uses body-embedded pagination links (not RFC5988 Link headers). Pagination information is provided in the links object within the response body:

The links object is included only when multiple pages exist. Within links, prev and/or next are present only when applicable. When a single page exists, the links field is omitted. This differs from other endpoints (such as /fd-api/v1/dispatches) which use RFC5988 Link headers for pagination. The links object is only included in the response when multiple pages exist. This differs from other endpoints (such as /fd-api/v1/dispatches) which use RFC5988 Link headers for pagination.

Example Request

curl -i -k -H "Authorization: Bearer <ACCESS_TOKEN>" "https://sizeup.firstduesizeup.com/fd-api/v1/personnel/list?page=1&page_size=20"

curl -i -k -H "Authorization: Bearer <ACCESS_TOKEN>" "https://sizeup.firstduesizeup.com/fd-api/v1/personnel/list?page=1&page_size=20&employment_status=active&is_field_crew_service_provider=true"

curl -i -k -H "Authorization: Bearer <ACCESS_TOKEN>" "https://sizeup.firstduesizeup.com/fd-api/v1/personnel/list?page=1&page_size=20&employment_status=active&is_field_crew_service_provider=true&personnel_id=123,456,789&first_due_id=123,456,789"

Success Response

HTTP/1.1 200 OK
{
  "status": "success",
  "message": "Personnel list retrieved successfully",
  "data": [
    {
      "id": 123,
      "uuid": "4d2cd84a-ce18-4e85-92b6-c3df39347374",
      "user_id": 456,
      "first_name": "Jared",
      "middle_name": "A",
      "last_name": "Barron",
      "preferred_name": "Jay",
      "name_suffix": "Jr.",
      "public_name": "Jared A Barron",
      "email": "jared.barron@example.com",
      "phone": "555-123-4567",
      "home_phone": "555-987-6543",
      "cad_personnel_id": "CAD123",
      "firefighter_id": "FF456",
      "payroll_id": "PAY789",
      "fema_id": "FEMA123",
      "dod_id": "DOD456",
      "badge_number": "B123",
      "agency_id": "AGENCY1",
      "created_at": "2024-01-15T10:30:00+00:00",
      "updated_at": "2024-10-15T14:20:00+00:00",
      "updated_by": 789,
      "status_code": "active",
      "is_active": true,
      "is_field_crew_service_provider": true,
      "is_training_instructor": false,
      "is_call_shift_eligible": true,
      "sync_to_admin_account": true,
      "start_date": "2020-01-01",
      "secondary_start_date": null,
      "start_date_ranking": 1,
      "end_of_service_date": null,
      "birth_date": "1990-05-15",
      "accrual_start_date": "2020-01-01",
      "driver_license_number": "D1234567",
      "driver_license_state": "CA",
      "driver_license_expiration_date": "2028-05-15",
      "drivers_license_class": ["A", "B"],
      "drivers_license_status": "valid",
      "schedule_message_method_codes": ["email", "sms"],
      "call_shift_method_codes": ["email"],
      "lunch_period_code": "30",
      "days_scheduled_code": "5",
      "hours_scheduled_code": "8",
      "gender_code": "M",
      "marital_status": "single",
      "citizenship_country_code": "US",
      "race": ["W"],
      "ethnicity_code": "N",
      "address": "123 Main Street",
      "city": "San Francisco",
      "state_code": "CA",
      "county_code": "SF",
      "zip": "94102",
      "unit": "Apt 5",
      "rank_id": 10,
      "ems_provider_level": "EMT-B",
      "career_volunteer": "career",
      "batt_dept_id": 1,
      "batt_dept_division_id": 2,
      "batt_dept_position_id": 3,
      "batt_dept_shift_id": 4,
      "batt_dept_district_id": 5,
      "fire_station_id": 6,
      "apparatus_id": 7,
      "inspector_number": "INS123",
      "inspector_designator": "IA",
      "investigator_number": "INV456",
      "iaff_local_number": "1234",
      "external_ids": [
        {
          "external_system_code": "SYSTEM1",
          "external_id": "EXT123"
        },
        {
          "external_system_code": "SYSTEM2",
          "external_id": "EXT456"
        }
      ]
    }
  ],
  "not_found_ids": [123, 456, 789],
  "page": 1,
  "page_size": 20,
  "total": 150,
  "total_pages": 8,
  "links": {
    "first": "https://sizeup.firstduesizeup.com/fd-api/v1/personnel/list?page=1&page_size=20",
    "next": "https://sizeup.firstduesizeup.com/fd-api/v1/personnel/list?page=2&page_size=20",
    "last": "https://sizeup.firstduesizeup.com/fd-api/v1/personnel/list?page=8&page_size=20"
  }
}

Response Fields

Personnel Record Fields:

Each personnel record in the data array includes all fields from the single personnel record endpoint, plus:

Error Response

HTTP/1.1 422 Unprocessable Entity
{
  "code": 0,
  "message": "Validation Failed. Please provide valid page, page_size parameters.",
  "errors": [
    {
      "field": "page",
      "code": "invalid",
      "message": "Please provide a valid page number."
    }
  ]
}

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

HTTP/1.1 500 Internal Server Error
{
  "code": 0,
  "message": "An unknown error occurred."
}

PUT /fd-api/v1/personnel/:id

Replace a personnel record completely.

PUT /fd-api/v1/personnel/:id

Parameters

Optional Workday / HRIS personnel fields (Charlotte Fire integration)

The same optional app.personnel fields documented under PATCH /fd-api/v1/personnel/:id in the subsection Optional Workday / HRIS personnel fields (Charlotte Fire integration) are accepted in the PUT JSON body. All are optional. Include them in the replace payload when persisting HRIS data; omission follows this endpoint’s full-replace contract for the rest of the personnel document.

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" -X PUT -H "Content-Type: application/json" -d '{
  "first_name": "John",
  "last_name": "Doe",
  "middle_name": "Michael",
  "preferred_name": "Johnny",
  "name_suffix": "Jr.",
  "public_name": "Johnny Doe",
  "email": "john.doe@example.com",
  "phone": "555-123-4567",
  "home_phone": "555-987-6543",
  "start_date": "2023-01-15",
  "birth_date": "1990-05-20",
  "gender_code": "M",
  "race": ["1", "2"],
  "ethnicity_code": "H",
  "marital_status": "S",
  "address": "123 Main Street",
  "city": "Anytown",
  "state_code": "CA",
  "zip": "12345",
  "unit": "Apt 4B",
  "county_code": "001",
  "citizenship_country_code": "US",
  "driver_license_number": "D123456789",
  "driver_license_state": "CA",
  "driver_license_class": ["A", "B"],
  "drivers_license_status": "V",
  "driver_license_expiration_date": "2025-12-31",
  "badge_number": "12345",
  "firefighter_id": "FF001",
  "payroll_id": "PAY001",
  "fema_id": "FEMA001",
  "dod_id": "DOD001",
  "cad_personnel_id": "CAD001",
  "iaff_local_number": "1234",
  "inspector_number": "INS001",
  "inspector_designator": "I",
  "investigator_number": "INV001",
  "fire_station_id": 1,
  "batt_dept_id": 1,
  "batt_dept_division_id": 1,
  "batt_dept_position_id": 1,
  "batt_dept_shift_id": 1,
  "batt_dept_district_id": 1,
  "rank_id": 1,
  "apparatus_id": 1,
  "agency_id": "AG001",
  "career_volunteer": "C",
  "ems_provider_level": 2,
  "is_field_crew_service_provider": true,
  "is_training_instructor": false,
  "is_call_shift_eligible": true,
  "sync_to_admin_account": true,
  "role": "firefighter",
  "status_code": "active",
  "schedule_message_method_codes": ["email", "sms"],
  "call_shift_method_codes": ["phone", "pager"],
  "lunch_period_code": "12:00-13:00",
  "days_scheduled_code": "M-F",
  "hours_scheduled_code": "08:00-17:00"
}' https://sizeup.firstduesizeup.com/fd-api/v1/personnel/123

Success Response

HTTP/1.1 200 OK
{
  "status": "success",
  "message": "Personnel record replaced successfully.",
  "data": {
    "id": 123,
    "first_name": "John",
    "last_name": "Doe",
    "middle_name": "Michael",
    "preferred_name": "Johnny",
    "name_suffix": "Jr.",
    "email": "john.doe@example.com",
    "public_name": "Johnny Doe",
    "phone": "555-123-4567",
    "uuid": "4d2cd84a-ce18-4e85-92b6-c3df39347374",
    "user_id": 456,
    "cad_personnel_id": "CAD001",
    "firefighter_id": "FF001",
    "payroll_id": "PAY001",
    "fema_id": "FEMA001",
    "dod_id": "DOD001",
    "created_at": "2023-01-15T10:30:00+00:00",
    "updated_at": "2024-01-15T14:30:00+00:00",
    "updated_by": 789,
    "status_code": "active",
    "is_active": true,
    "is_field_crew_service_provider": true,
    "is_training_instructor": false,
    "is_call_shift_eligible": true,
    "sync_to_admin_account": true,
    "start_date": "2023-01-15",
    "secondary_start_date": null,
    "start_date_ranking": null,
    "end_of_service_date": null,
    "birth_date": "1990-05-20",
    "accrual_start_date": null,
    "driver_license_expiration_date": "2025-12-31",
    "batt_dept_id": 1,
    "batt_dept_division_id": 1,
    "batt_dept_position_id": 1,
    "batt_dept_shift_id": 1,
    "batt_dept_district_id": 1,
    "driver_license_number": "D123456789",
    "driver_license_state": "CA",
    "drivers_license_class": ["A", "B"],
    "schedule_message_method_codes": ["email", "sms"],
    "call_shift_method_codes": ["phone", "pager"],
    "lunch_period_code": "12:00-13:00",
    "days_scheduled_code": "M-F",
    "hours_scheduled_code": "08:00-17:00",
    "gender_code": "M",
    "marital_status": "S",
    "citizenship_country_code": "US",
    "race": ["1", "2"],
    "ethnicity_code": "H",
    "address": "123 Main Street",
    "city": "Anytown",
    "state_code": "CA",
    "county_code": "001",
    "zip": "12345",
    "unit": "Apt 4B",
    "home_phone": "555-987-6543",
    "rank_id": 1,
    "ems_provider_level": 2,
    "career_volunteer": "C",
    "badge_number": "12345",
    "agency_id": "AG001",
    "fire_station_id": 1,
    "apparatus_id": 1,
    "inspector_number": "INS001",
    "inspector_designator": "I",
    "investigator_number": "INV001",
    "iaff_local_number": "1234",
    "drivers_license_status": "V"
  }
}

Error Response

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

HTTP/1.1 400 Bad Request
{
  "code": 0,
  "message": "Personnel data validation failed.",
  "errors": {
    "first_name": "The first_name field is required.",
    "email": "Invalid email format: invalid-email (expected format: user@domain.com)",
    "birth_date": "Invalid birth_date format: 1990/05/20 (expected format: 2024-01-15)"
  }
}

HTTP/1.1 404 Not Found
{
  "code": 0,
  "message": "Personnel record not found or update failed."
}

GET /fd-api/v1/personnel/:id

Get a single personnel record by ID.

GET /fd-api/v1/personnel/:id

Parameters

Example Request

$ curl -i -k -H "Authorization: Bearer 4cc212aac77dad9f9e1e5e2b2be5dd5a" https://sizeup.firstduesizeup.com/fd-api/v1/personnel/123

Success Response

HTTP/1.1 200 OK
{
  "status": "success",
  "data": {
    "id": 123,
    "uuid": "4d2cd84a-ce18-4e85-92b6-c3df39347374",
    "user_id": 456,
    "first_name": "Jared",
    "middle_name": "A",
    "last_name": "Barron",
    "preferred_name": "Jay",
    "name_suffix": "Jr.",
    "public_name": "Jared A Barron",
    "email": "jared.barron@example.com",
    "phone": "555-123-4567",
    "home_phone": "555-987-6543",
    "cad_personnel_id": "CAD123",
    "firefighter_id": "FF456",
    "payroll_id": "PAY789",
    "fema_id": "FEMA123",
    "dod_id": "DOD456",
    "badge_number": "B123",
    "agency_id": "AGENCY1",
    "created_at": "2024-01-15T10:30:00+00:00",
    "updated_at": "2024-10-15T14:20:00+00:00",
    "updated_by": 789,
    "status_code": "active",
    "is_active": true,
    "is_field_crew_service_provider": true,
    "is_training_instructor": false,
    "is_call_shift_eligible": true,
    "sync_to_admin_account": true,
    "start_date": "2020-01-01",
    "secondary_start_date": null,
    "start_date_ranking": 1,
    "end_of_service_date": null,
    "birth_date": "1990-05-15",
    "accrual_start_date": "2020-01-01",
    "driver_license_number": "D1234567",
    "driver_license_state": "CA",
    "driver_license_expiration_date": "2028-05-15",
    "drivers_license_class": ["A", "B"],
    "drivers_license_status": "valid",
    "schedule_message_method_codes": ["email", "sms"],
    "call_shift_method_codes": ["email"],
    "lunch_period_code": "30",
    "days_scheduled_code": "5",
    "hours_scheduled_code": "8",
    "gender_code": "M",
    "marital_status": "single",
    "citizenship_country_code": "US",
    "race": ["W"],
    "ethnicity_code": "N",
    "address": "123 Main Street",
    "city": "San Francisco",
    "state_code": "CA",
    "county_code": "SF",
    "zip": "94102",
    "unit": "Apt 5",
    "rank_id": 10,
    "ems_provider_level": "EMT-B",
    "career_volunteer": "career",
    "batt_dept_id": 1,
    "batt_dept_division_id": 2,
    "batt_dept_position_id": 3,
    "batt_dept_shift_id": 4,
    "batt_dept_district_id": 5,
    "fire_station_id": 6,
    "apparatus_id": 7,
    "inspector_number": "INS123",
    "inspector_designator": "IA",
    "investigator_number": "INV456",
    "iaff_local_number": "1234",
    "workday_employee_name": null,
    "master_seniority": null,
    "ops_hire_date": null,
    "promotion_title": null,
    "promotion_date": null
  }
}

Error Response

HTTP/1.1 400 Bad Request
{
  "code": 0,
  "message": "Invalid personnel ID."
}

HTTP/1.1 401 Unauthorized
{
  "code": 0,
  "message": "Your request was made with invalid credentials."
}

HTTP/1.1 403 Forbidden
{
  "code": 0,
  "message": "You are not authorized to perform this action."
}

HTTP/1.1 404 Not Found
{
  "code": 0,
  "message": "Personnel record not found."
}

POST /fd-api/v1/personnel

Create a new personnel record.

POST /fd-api/v1/personnel

Parameters