BeginOfService/v1/Update

Endpoint Description

Provides paginated list if machine that have not been activated yet.

Request Information

URI

Authorize POSThttps://api20.takeuchi-us.com/BeginOfService/v1/Update

URI Parameters

None (Empty)

Header Parameters

Key	Value	Description	Requirements
Authorization	Bearer *Token generated from Connect endpoints.	Authorization is required to access this endpoint.	Required
Accept	/ \| application/xml \| application/json	By default responses will be "application/json".	Optional

Body Parameters

BeginOfService

Name	Description	Type	Additional Information
links	Links are used to describe the meta data about call. Each link contains a relationship (rel) and a hyper-link (href).	Collection of Links	Single element activations may not contain links.
activations	Contains data points related to the non-activated machine's data.	Collection of Activation	Single element activations will contain a single activation.
actions	Available actions that can be performed on non-activated machines.	Collection of Action
version	Declaration Version specifies the version of the response conforms.	string

Request Formats

{
  "links": [
    {
      "rel": "sample string 1",
      "href": "sample string 2"
    },
    {
      "rel": "sample string 1",
      "href": "sample string 2"
    }
  ],
  "activations": [
    {
      "actions": [
        {
          "type": 1,
          "name": "sample string 2"
        },
        {
          "type": 1,
          "name": "sample string 2"
        }
      ],
      "activate": true,
      "company": {
        "name": "sample string 1"
      },
      "block": true,
      "error": {
        "Status": "sample string 1",
        "Message": "sample string 2"
      },
      "gps": {
        "serial": "sample string 1"
      },
      "eta": "2025-04-19T07:46:30.4197262-04:00",
      "machine": {
        "serial": "sample string 1",
        "model": {
          "name": "sample string 1",
          "year": 1
        }
      }
    },
    {
      "actions": [
        {
          "type": 1,
          "name": "sample string 2"
        },
        {
          "type": 1,
          "name": "sample string 2"
        }
      ],
      "activate": true,
      "company": {
        "name": "sample string 1"
      },
      "block": true,
      "error": {
        "Status": "sample string 1",
        "Message": "sample string 2"
      },
      "gps": {
        "serial": "sample string 1"
      },
      "eta": "2025-04-19T07:46:30.4197262-04:00",
      "machine": {
        "serial": "sample string 1",
        "model": {
          "name": "sample string 1",
          "year": 1
        }
      }
    }
  ],
  "actions": [
    {
      "type": 1,
      "name": "sample string 2"
    },
    {
      "type": 1,
      "name": "sample string 2"
    }
  ],
  "version": "sample string 1"
}

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'BeginOfService'.

Response Information

Resource Description

BeginOfService

Name	Description	Type	Additional Information
links	Links are used to describe the meta data about call. Each link contains a relationship (rel) and a hyper-link (href).	Collection of Links	Single element activations may not contain links.
activations	Contains data points related to the non-activated machine's data.	Collection of Activation	Single element activations will contain a single activation.
actions	Available actions that can be performed on non-activated machines.	Collection of Action
version	Declaration Version specifies the version of the response conforms.	string

Response Formats

{
  "links": [
    {
      "rel": "sample string 1",
      "href": "sample string 2"
    },
    {
      "rel": "sample string 1",
      "href": "sample string 2"
    }
  ],
  "activations": [
    {
      "actions": [
        {
          "type": 1,
          "name": "sample string 2"
        },
        {
          "type": 1,
          "name": "sample string 2"
        }
      ],
      "activate": true,
      "company": {
        "name": "sample string 1"
      },
      "block": true,
      "error": {
        "Status": "sample string 1",
        "Message": "sample string 2"
      },
      "gps": {
        "serial": "sample string 1"
      },
      "eta": "2025-04-19T07:46:30.4197262-04:00",
      "machine": {
        "serial": "sample string 1",
        "model": {
          "name": "sample string 1",
          "year": 1
        }
      }
    },
    {
      "actions": [
        {
          "type": 1,
          "name": "sample string 2"
        },
        {
          "type": 1,
          "name": "sample string 2"
        }
      ],
      "activate": true,
      "company": {
        "name": "sample string 1"
      },
      "block": true,
      "error": {
        "Status": "sample string 1",
        "Message": "sample string 2"
      },
      "gps": {
        "serial": "sample string 1"
      },
      "eta": "2025-04-19T07:46:30.4197262-04:00",
      "machine": {
        "serial": "sample string 1",
        "model": {
          "name": "sample string 1",
          "year": 1
        }
      }
    }
  ],
  "actions": [
    {
      "type": 1,
      "name": "sample string 2"
    },
    {
      "type": 1,
      "name": "sample string 2"
    }
  ],
  "version": "sample string 1"
}

Return