REST API Scan

<<- Back to REST API Home

Index

• Add Board
• Delete Board
• All Boards
• First Board
• Last Board
• Query Board

Add Board

Description

Adds a Board to the Scan Station Queue

URL

POST /api/multiplug.ext.hermes/scan/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 Scan Station Queue

URL

POST /api/multiplug.ext.hermes/scan/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 Scan Station Queue

URL

GET /api/multiplug.ext.hermes/scan/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 Scan Station Queue

URL

GET /api/multiplug.ext.hermes/scan/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 Scan Station Queue

URL

GET /api/multiplug.ext.hermes/scan/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/scan/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