Trimble Special Event Codes API

Retrieves and creates TruckMate special event codes. Special event codes can be viewed and maintained in the Special Events application > Codes tab.

GitHub OpenAPI

Operations 5

GET /specialEventCodes Retrieve special event codes #
POST /specialEventCodes Create new special event codes #
GET /specialEventCodes/{specialEventCodeId} Retrieve a special event code #
DELETE /specialEventCodes/{specialEventCodeId} Delete a special event code #
PUT /specialEventCodes/{specialEventCodeId} Update a special event code #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/trimble:trimble-special-event-codes-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

trimble-special-event-codes-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: MasterData Special Event Codes API
  description: 'The Master Data management API allows for an external system to create, retrieve, update or delete TruckMate configuration data, such as Client, Vendor and Driver profiles, as well as sites, zones, commodity codes etc.


    Download latest released OpenAPI


    This documentation is based on the most currently released version of TruckMate. Documentation for previous versions can be accessed by navigating to the openapi.json endpoint for any given API (the service must be set up and running). For example: http://DOMAIN/openapi.json


    ---


    © 2026, Trimble Inc. All rights reserved. Unauthorized copying prohibited. Software functions, including our APIs and their specification, are subject to change without notice. Information contained herein is Trimble Confidential Information, used under license.


    ---'
  version: '1'
  x-tm-release: 26.3.125.0
tags:
- name: Special Event Codes
  description: Retrieves and creates TruckMate special event codes. Special event codes can be viewed and maintained in the Special Events application > Codes tab.
paths:
  /specialEventCodes:
    get:
      summary: Retrieve special event codes
      description: 'Retrieve special event code records.


        Special event codes can be viewed in the Special Events application > Codes tab.'
      operationId: GetSpecialEventCodes
      security:
      - truckmateApiKeyAuth: []
      - webuserJwtAuth: []
      - tidJwtAuth: []
      tags:
      - Special Event Codes
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/orderBy'
      - $ref: '#/components/parameters/select'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSpecialEventCodes200'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
    post:
      summary: Create new special event codes
      description: 'Creates one or more special event code records.


        The specialEventCode must be included in the request body for each record.


        Special event codes can be viewed in the Special Events application > Codes tab.'
      operationId: PostSpecialEventCodes
      security:
      - truckmateApiKeyAuth: []
      tags:
      - Special Event Codes
      requestBody:
        description: An array of JSON objects containing the properties of the special event code to be created.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RefSpecialEventCodesPostRequest'
      parameters:
      - $ref: '#/components/parameters/select'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostSpecialEventCodes201'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
  /specialEventCodes/{specialEventCodeId}:
    parameters:
    - name: specialEventCodeId
      in: path
      description: special event code identifier
      required: true
      schema:
        type: string
    get:
      summary: Retrieve a special event code
      description: 'Retrieve a special event code record.


        Special event codes can be viewed in the Special Events application > Codes tab.'
      operationId: GetSpecialEventCode
      security:
      - truckmateApiKeyAuth: []
      - webuserJwtAuth: []
      - tidJwtAuth: []
      tags:
      - Special Event Codes
      parameters:
      - $ref: '#/components/parameters/select'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/specialEventCode'
                - type: object
                  properties:
                    href:
                      type: string
                      readOnly: true
                      description: Self-referencing URL for this resource
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
    delete:
      summary: Delete a special event code
      description: 'Deletes a specific special event code record.


        Related special event data rows are set to HISTORY status before the code is removed. The system code MAINT cannot be deleted. Recurring special event rows are not removed by this endpoint.


        Special event codes can be viewed in the Special Events application > Codes tab.'
      operationId: DeleteSpecialEventCode
      security:
      - truckmateApiKeyAuth: []
      tags:
      - Special Event Codes
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
    put:
      summary: Update a special event code
      description: 'Updates one or more properties of a specific special event code record.


        Special event codes can be viewed in the Special Events application > Codes tab.'
      operationId: PutSpecialEventCode
      security:
      - truckmateApiKeyAuth: []
      tags:
      - Special Event Codes
      requestBody:
        description: A JSON object containing the properties of the special event code to be updated.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RefSpecialEventCodePutRequest'
      parameters:
      - $ref: '#/components/parameters/select'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/specialEventCode'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
components:
  parameters:
    offset:
      name: offset
      in: query
      description: Specifies the number of items to skip before beginning to select the records to return.
      required: false
      style: form
      explode: true
      schema:
        type: integer
        default: 0
    select:
      name: $select
      in: query
      description: Select allows to request a specified set of properties, see [Selecting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part2-url-conventions.html#_Toc31361040)
      required: false
      style: form
      explode: true
      schema:
        type: string
    limit:
      name: limit
      in: query
      description: Specifies the maximum number of items to include in the response results.
      required: false
      style: form
      explode: true
      schema:
        type: integer
        default: 20
    orderBy:
      name: $orderBy
      in: query
      description: Field(s) to order returned resource by, with optional direction. E.g., "fieldName desc, fieldName2"
      required: false
      style: form
      explode: true
      schema:
        type: string
    filter:
      name: $filter
      in: query
      description: Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter). Note, not all features of oData filter syntax are supported.
      required: false
      style: form
      explode: true
      schema:
        type: string
  schemas:
    ARTError:
      type: object
      properties:
        type:
          type: string
        title:
          type: string
        code:
          type: string
          description: Error code (optional, deprecated; omitted in Mobile Comm)
          deprecated: true
        description:
          type: string
          description: Human-readable description (optional, deprecated; omitted in Mobile Comm)
          deprecated: true
    RefSpecialEventCodesPostRequest:
      type: object
      properties:
        specialEventCodes:
          type: array
          items:
            $ref: '#/components/schemas/RefSpecialEventCodePostRequest'
    specialEventCode:
      type: object
      properties:
        specialEventCode:
          type: string
          maxLength: 10
        description:
          type: string
          maxLength: 40
        stopUse:
          type: string
          enum:
          - 'False'
          - 'True'
          - ''
          default: 'False'
        stopUseLevel:
          type:
          - string
          - 'null'
          enum:
          - match
          - dispatch
          - both
          - ''
          - null
        dateLevel1:
          type:
          - integer
          - 'null'
          default: 7
        dateLevel2:
          type:
          - integer
          - 'null'
          default: 3
        percentLevel1:
          type:
          - integer
          - 'null'
        percentLevel2:
          type:
          - integer
          - 'null'
        copyDescription:
          type: string
          enum:
          - 'False'
          - 'True'
          - ''
          default: 'False'
        resultsRequired:
          type: string
          enum:
          - 'False'
          - 'True'
          - ''
          default: 'False'
        isMobileCommEnabled:
          type: string
          enum:
          - 'False'
          - 'True'
          - ''
          default: 'False'
        recurringDailyAfter:
          type:
          - integer
          - 'null'
    GetSpecialEventCodes200:
      type: object
      properties:
        href:
          type: string
          readOnly: true
          description: Self-referencing URL for this resource
        offset:
          type: integer
        limit:
          type: integer
        filter:
          type: string
        sort:
          type: string
        select:
          type: string
        count:
          type: integer
        specialEventCodes:
          type: array
          items:
            $ref: '#/components/schemas/specialEventCode'
    ARTErrors:
      type: object
      properties:
        type:
          type: string
        title:
          type: string
        status:
          type: integer
          enum:
          - 400
          - 401
          - 403
          - 404
          - 405
          - 409
          - 429
          - 500
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ARTError'
    RefSpecialEventCodePostRequest:
      type: object
      properties:
        specialEventCode:
          type: string
          maxLength: 10
        description:
          type: string
          maxLength: 40
        stopUse:
          type: string
          enum:
          - 'False'
          - 'True'
          default: 'False'
        stopUseLevel:
          type:
          - string
          - 'null'
          enum:
          - match
          - dispatch
          - both
          - null
        dateLevel1:
          type: integer
          default: 7
        dateLevel2:
          type: integer
          default: 3
        percentLevel1:
          type: integer
        percentLevel2:
          type: integer
        copyDescription:
          type: string
          enum:
          - 'False'
          - 'True'
          default: 'False'
        resultsRequired:
          type: string
          enum:
          - 'False'
          - 'True'
          default: 'False'
        isMobileCommEnabled:
          type: string
          enum:
          - 'False'
          - 'True'
          default: 'False'
        recurringDailyAfter:
          type: integer
      required:
      - specialEventCode
    RefSpecialEventCodePutRequest:
      type: object
      properties:
        description:
          type: string
          maxLength: 40
        stopUse:
          type: string
          enum:
          - 'False'
          - 'True'
          default: 'False'
        stopUseLevel:
          type: string
          enum:
          - match
          - dispatch
          - both
          - ''
        dateLevel1:
          type: integer
          default: 7
        dateLevel2:
          type: integer
          default: 3
        percentLevel1:
          type: integer
        percentLevel2:
          type: integer
        copyDescription:
          type: string
          enum:
          - 'False'
          - 'True'
          default: 'False'
        resultsRequired:
          type: string
          enum:
          - 'False'
          - 'True'
          default: 'False'
        isMobileCommEnabled:
          type: string
          enum:
          - 'False'
          - 'True'
          default: 'False'
        recurringDailyAfter:
          type: integer
    PostSpecialEventCodes201:
      type: object
      properties:
        specialEventCodes:
          type: array
          items:
            $ref: '#/components/schemas/specialEventCode'
  securitySchemes:
    tidJwtAuth:
      type: http
      description: A time-limited JSON Web Token generated via separate POST request using TID
      scheme: bearer
    webuserJwtAuth:
      type: http
      description: A fresh JSON Web Token expires in four hours. It can be renewed by making a GET request to /login endpoint, or generated by making a POST request to /login endpoint
      scheme: bearer
    truckmateApiKeyAuth:
      type: http
      description: TruckMate API Key
      scheme: bearer
externalDocs:
  url: https://learn.transportation.trimble.com/