Skip to content

REST API This

Jump to bottom
4IR.UK edited this page Oct 10, 2024 · 24 revisions

<<- Back to REST API Home

Index

SMEMA

Boards

Hermes

All SMEMA

Description

Returns All the SMEMA I/O States. For arrays, Index zero(0) is the aggregate result for all proceeding values. Index zero is therefore the value of interest.

URL

GET /api/multiplug.ext.hermes/smema/

Data

  • String lane Optional. Guid of the Lane. If not specified then first lane will be used.

JSON Response Example

{
    "upstream": {
        "ready": [
            true,
            true
        ],
        "good": false,
        "bad": false
    },
    "downstream": {
        "ready": false,
        "good": [
            false,
            false
        ],
        "bad": [
            false,
            false
        ]
    }
}

HTTP Response Codes

  • 200 OK
  • 403 Forbidden - API Not Enabled

Upstream SMEMA

Description

Returns the Upstream SMEMA I/O States. For arrays, Index zero(0) is the aggregate result for all proceeding values. Index zero is therefore the value of interest.

URL

GET /api/multiplug.ext.hermes/smema/up/

Data

  • String lane Optional. Guid of the Lane. If not specified then first lane will be used.

JSON Response Example

{
    "ready": [
        true,
        true
    ],
    "good": false,
    "bad": false
}

HTTP Response Codes

  • 200 OK
  • 403 Forbidden - API Not Enabled

Downstream SMEMA

Description

Returns the Downstream SMEMA I/O States. For arrays, Index zero(0) is the aggregate result for all proceeding values. Index zero is therefore the value of interest.

URL

GET /api/multiplug.ext.hermes/smema/down/

Data

  • String lane Optional. Guid of the Lane. If not specified then first lane will be used.

JSON Response Example

{
    "ready": false,
    "good": [
        false,
        false
    ],
    "bad": [
        false,
        false
    ]
}

HTTP Response Codes

  • 200 OK
  • 403 Forbidden - API Not Enabled

Add Board

Description

Adds a Board to This Station Queue

URL

POST /api/multiplug.ext.hermes/this/boards/new/

Data

  • String lane Optional. Guid of the Lane. If not specified then first lane will be used.
  • String boardid
  • String boardidcreatedby
  • Int failedboard
  • String producttypeid
  • Int flippedboard
  • String topbarcode
  • String bottombarcode
  • String length
  • String width
  • String thickness
  • String conveyorspeed
  • String topclearanceheight
  • String bottomclearanceheight
  • String weight
  • String workorderid
  • String batchid
  • Int route
  • Int action
  • Int Array Pos SubBoards Position. Length must match Bc and St
  • String Array Bc SubBoards Barcode. Length must match Pos and St
  • Int Array St SubBoards State. Length must match Pos and Bc

HTTP Response Codes

  • 200 OK
  • 400 Unprocessed - Lane Not Found. If lane guid not specified, no lanes are setup.
  • 422 Unprocessed - Missing Compulsory Value
  • 422 Unprocessed - Malformed Request: SubBoards.
  • 403 Forbidden - API Not Enabled

Delete Board

Description

Deletes a Board from the This Station Queue

URL

POST /api/multiplug.ext.hermes/this/boards/delete/

Data

  • String lane Optional. Guid of the Lane. If not specified then first lane will be used.
  • String guid The Guid of the Board

HTTP Response Codes

  • 200 OK
  • 422 Unprocessed - Lane Not Found. If lane guid not specified, no lanes are setup.
  • 422 Unprocessed - Missing Board Guid
  • 422 Unprocessed - Board Not Found
  • 403 Forbidden - API Not Enabled

All Boards

Description

Returns all Boards from This Station Queue

URL

GET /api/multiplug.ext.hermes/this/boards/all/

Data

  • String lane Optional. Guid of the Lane. If not specified then first lane will be used.

JSON Response Example

[
    {
        "guid": "0c6ff39d-7165-445c-8116-187cab84c8fc",
        "boardId": "5859f008-4328-48e8-99e4-c33a7f7cc3a1",
        "boardIdCreatedBy": "DEK NeoHorizon",
        "failedBoard": 1,
        "productTypeId": "Product Type 01",
        "flippedBoard": 1,
        "topBarcode": "0123456789",
        "bottomBarcode": "9876543210",
        "length": 2.0,
        "width": 1.0,
        "thickness": 3.0,
        "conveyorSpeed": 4.0,
        "topClearanceHeight": 5.0,
        "bottomClearanceHeight": 6.0,
        "weight": 7.0,
        "workOrderId": "Work Order 02",
        "batchId": "0001"
    }
]

HTTP Response Codes

  • 200 OK
  • 400 Bad Request - Lane Not Found. If lane guid not specified, no lanes are setup.
  • 403 Forbidden - API Not Enabled

First Board

Description

Returns the First Board from This Station Queue

URL

GET /api/multiplug.ext.hermes/this/boards/first/

Data

  • String lane Optional. Guid of the Lane. If not specified then first lane will be used.

JSON Response Example

{
    "guid": "0c6ff39d-7165-445c-8116-187cab84c8fc",
    "boardId": "5859f008-4328-48e8-99e4-c33a7f7cc3a1",
    "boardIdCreatedBy": "DEK NeoHorizon",
    "failedBoard": 1,
    "productTypeId": "Product Type 01",
    "flippedBoard": 1,
    "topBarcode": "0123456789",
    "bottomBarcode": "9876543210",
    "length": 2.0,
    "width": 1.0,
    "thickness": 3.0,
    "conveyorSpeed": 4.0,
    "topClearanceHeight": 5.0,
    "bottomClearanceHeight": 6.0,
    "weight": 7.0,
    "workOrderId": "Work Order 02",
    "batchId": "0001"
}

HTTP Response Codes

  • 200 OK
  • 400 Bad Request - Lane Not Found. If lane guid not specified, no lanes are setup.
  • 400 Bad Request - First Board Not Found
  • 403 Forbidden - API Not Enabled

Last Board

Description

Returns the Last Board from This Station Queue

URL

GET /api/multiplug.ext.hermes/this/boards/last/

Data

  • String lane Optional. Guid of the Lane. If not specified then first lane will be used.

JSON Response Example

{
    "guid": "0c6ff39d-7165-445c-8116-187cab84c8fc",
    "boardId": "5859f008-4328-48e8-99e4-c33a7f7cc3a1",
    "boardIdCreatedBy": "DEK NeoHorizon",
    "failedBoard": 1,
    "productTypeId": "Product Type 01",
    "flippedBoard": 1,
    "topBarcode": "0123456789",
    "bottomBarcode": "9876543210",
    "length": 2.0,
    "width": 1.0,
    "thickness": 3.0,
    "conveyorSpeed": 4.0,
    "topClearanceHeight": 5.0,
    "bottomClearanceHeight": 6.0,
    "weight": 7.0,
    "workOrderId": "Work Order 02",
    "batchId": "0001"
}

HTTP Response Codes

  • 200 OK
  • 400 Bad Request - Lane Not Found. If lane guid not specified, no lanes are setup.
  • 400 Bad Request - Last Board Not Found
  • 403 Forbidden - API Not Enabled

Query Board

Description

Returns a Board record with the specified Top or Bottom Barcode

URL

GET /api/multiplug.ext.hermes/this/boards/query/

Data

  • String lane Optional. Guid of the Lane. If not specified then first lane will be used.
  • String guid Optional. The Guid of the Board
  • String topbarcode Optional. The Top Barcode of the Board
  • String bottombarcode Optional. Bottom Barcode of the Board

Note: Either guid, topbarcode or bottombarcode should be used.

JSON Response Example

{
    "guid": "0c6ff39d-7165-445c-8116-187cab84c8fc",
    "boardId": "5859f008-4328-48e8-99e4-c33a7f7cc3a1",
    "boardIdCreatedBy": "DEK NeoHorizon",
    "failedBoard": 1,
    "productTypeId": "Product Type 01",
    "flippedBoard": 1,
    "topBarcode": "0123456789",
    "bottomBarcode": "9876543210",
    "length": 2.0,
    "width": 1.0,
    "thickness": 3.0,
    "conveyorSpeed": 4.0,
    "topClearanceHeight": 5.0,
    "bottomClearanceHeight": 6.0,
    "weight": 7.0,
    "workOrderId": "Work Order 02",
    "batchId": "0001"
}

HTTP Response Codes

  • 200 OK
  • 400 Bad Request - Lane Not Found. If lane guid not specified, no lanes are setup.
  • 400 Bad Request - Board Not Found
  • 403 Forbidden - API Not Enabled

Hermes Service Description

Description

Returns the Hermes Service Description for this machine

URL

GET /api/multiplug.ext.hermes/this/hermes/servicedescription/

Data

  • String lane Optional. Guid of the Lane. If not specified then first lane will be used.

JSON Response Example

{
    "upstream": {
        "machineId": "Conveyor",
        "laneId": 1,
        "interfaceId": "UpInterface",
        "version": "1.5",
        "supportedFeatures": {
            "featureCheckAliveResponse": true,
            "featureBoardForecast": true,
            "featureQueryBoardInfo": true,
            "featureCommand": true
        }
    },
    "downstream": {
        "machineId": "Conveyor",
        "laneId": 1,
        "interfaceId": "DownInterface",
        "version": "1.5",
        "supportedFeatures": {
            "featureCheckAliveResponse": true,
            "featureBoardForecast": true,
            "featureSendBoardInfo": true,
            "featureCommand": true
        }
    }
}

HTTP Response Codes

  • 200 OK
  • 400 Bad Request - Lane Not Found. If lane guid not specified, no lanes are setup.
  • 403 Forbidden - API Not Enabled

Clone this wiki locally