Fieldmotion API Getting started

Digital Waste Tracking

Page receiving profiles

POST /a/DigitalWasteTracking_profiles

Search receiving sites and return display columns alongside the masked editable profile.

When to use this endpoint

Use for the receiving-site table; settingsGet returns the unpaginated underlying settings object instead.

Authentication and permissions

Authenticate with signed API-key fields or a logged-in CRM session; session dispatch applies CSRF checks. The authenticated tenant must have features2.ukDigitalWasteManagement=1. The feature is read from the account record, not trusted from request input.

Requires client-administrator access. A page Edit permission or wildcard role alone does not replace the client-admin check.

Parameters

ParameterTypeRequiredDescription
start, length, drawInteger-compatibleNoOffset (default 0), page size (default 10, clamped 1–500) and echoed draw (default 0). This is not page/limit pagination.
searchValue, searchFieldStringsNoCase-insensitive substring search. searchField defaults to All; unsupported field names normally match no nonblank search.
orderBy, orderDescStringsNoSort by a returned property; only a case-insensitive desc value reverses the default ascending natural string comparison.
id, name, environment, submission_mode, site_name, authorisation_number, postcode, active, is_defaultScalar or native arrayNoExact filters. active uses Active/Archived and is_default uses Yes/No; these are display strings, not booleans.

Example request

$result = FM_api('DigitalWasteTracking_profiles', [
	'start'=>'0',
	'length'=>'10',
	'searchValue'=>'North',
	'searchField'=>'All',
]);

Example response

{
  "draw": 0,
  "recordsTotal": 1,
  "recordsFiltered": 1,
  "data": [
    {
      "id": "aaaaaaaaaaaaaaaa",
      "name": "North receiving site",
      "environment": "test",
      "submission_mode": "manual",
      "site_name": "North receiving site",
      "authorisation_number": "EPR/AB1234CD",
      "postcode": "BT1 1AA",
      "api_code_status": "Not configured",
      "active": "Active",
      "is_default": "Yes",
      "profile": {
        "id": "aaaaaaaaaaaaaaaa",
        "name": "North receiving site",
        "environment": "test",
        "receiving_site": {
          "receiver": {
            "siteName": "North receiving site",
            "authorisationNumber": "EPR/AB1234CD",
            "emailAddress": "waste@example.test",
            "phoneNumber": "",
            "regulatoryPositionStatements": []
          },
          "address": {
            "fullAddress": "1 Synthetic Road",
            "postcode": "BT1 1AA"
          }
        },
        "submission_mode": "manual",
        "active": 1,
        "api_code_masked": "",
        "revision": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
      }
    }
  ]
}

Errors and unusual responses

ResponseCondition
{"error":"not logged in"}No authenticated tenant context is available. Invalid signed credentials can be rejected by the dispatcher before the handler runs.
{"error":"UK Digital Waste Tracking is not enabled for this account"}The account feature is disabled.
{"error":"client administrator access required"}The identity is not a client administrator.

Legacy application errors may be returned with HTTP 200. Check the decoded response for error, not only the HTTP status.

Behaviour and edge cases

  • For array-backed tables, start defaults to 0 and is clamped to at least 0; length defaults to 10 and is clamped to 1–500 (length=-1 means 1, not all). draw is integer-converted. searchValue is HTML-entity-decoded, trimmed and matched as a case-insensitive substring; searchField=All searches the listed searchable columns. Exact field filters accept one value or a native array of values, combine with AND, and ignore blank/empty lists. orderBy names an actual row property; orderDesc=desc reverses a natural, case-insensitive string comparison. Unknown sort names preserve source order. Counts are before and after these in-memory filters.
  • Always returns a table envelope, even if isTable is absent. Includes archived sites and the nested masked profile; no provider request is made. api_code_status and profile are not normal searchable/exact-filter columns, although orderBy can name any returned property.
  • Default source order is stored profile order. Active/default display values are English literals; do not filter them using 0/1.

See it in Fieldmotion

CRM1

No direct CRM1 caller was found in the production JavaScript source. The operator workflow is implemented in CRM2.

CRM2

Open Settings > Digital Waste Tracking; the standard widget table calls DigitalWasteTracking_profiles with offset, page size, searches and column filters.

Related endpoints