Scanners Endpoint

registration of hardware scanners used for ACH transactions

Capabilities

Methods	POST, PUT, GET, DELETE
Filters	title, serial_number, scanner_model_id
Expands	scanner_model, location, created_user, scanner_manufacturer

Fields

Name	Format	Length	Default	Comments
id	string	24	System Generated	ID
title	string	24		Ttile of the scanner
serial_number	string	24		the scanner's serial number
scanner_model_id	integer	10		the ID of the scanner's model that can be accessed via `v2/scannermodels`
created_ts	integer	10	System Generated
created_user_id	string	36	System Generated
modified_ts	integer	10	System Generated
modified_user_id	string	36	System Generated
active	boolean	1		active

Endpoint Actions

Create Record

POST /v2/scanners

{
    "scanner":{
        "scanner_model_id":4,
        "title":"my scanner",
        "serial_number":"123456",
        "location_id":"11111111-1111-1111-1111-111111111111"
    }
}

{
    "scanner": {
        "id": "11ead7f68d2c5a228a6bc8d8",
        "title": "my scanner",
        "location_id": "11111111-1111-1111-1111-111111111111",
        "serial_number": "123456",
        "scanner_model_id": 4,
        "created_ts": 1596726451,
        "created_user_id": "11111111-1111-1111-1111-111111111111",
        "modified_ts": 1596726451,
        "modified_user_id": "11111111-1111-1111-1111-111111111111",
        "active": 1
    }
}

Update Record

PUT /v2/scanners/{id}

{
    "scanner":{
        "title":"new Title"
    }
}

{
    "scanner": {
        "id": "11ead7f68d2c5a228a6bc8d8",
        "title": "new Title",
        "location_id": "11111111-1111-1111-1111-111111111111",
        "serial_number": "123456",
        "scanner_model_id": 4,
        "created_ts": 1596726451,
        "created_user_id": "11111111-1111-1111-1111-111111111111",
        "modified_ts": 1596727300,
        "modified_user_id": "11111111-1111-1111-1111-111111111111",
        "active": 1
    }
}

View Single Record

GET/v2/scanners/{id}

{
    // Empty Payload - Nothing Needed Here
}

{
    "scanner": {
        "id": "11ead7f68d2c5a228a6bc8d8",
        "title": "new Title",
        "location_id": "11111111-1111-1111-1111-111111111111",
        "serial_number": "123456",
        "scanner_model_id": 4,
        "created_ts": 1596726451,
        "created_user_id": "11111111-1111-1111-1111-111111111111",
        "modified_ts": 1596727300,
        "modified_user_id": "11111111-1111-1111-1111-111111111111",
        "active": 1
    }
}

View Record List

GET /v2/scanners

Note: Filters can be used to search for Scanners by including the columns you want to filter on as URL parameters. i.e. /v2/scanners?title=something&serial_number=12345

{
    // Empty Payload - Nothing Needed Here
}

{
    "scanners": [
        {
            "id": "11ead7fad67d92beb8863a4b",
            "title": "Super scanner",
            "location_id": "11111111-1111-1111-1111-111111111111",
            "serial_number": "123456",
            "scanner_model_id": 2,
            "created_ts": 1596728292,
            "created_user_id": "11111111-1111-1111-1111-111111111111",
            "modified_ts": 1596728292,
            "modified_user_id": "11111111-1111-1111-1111-111111111111",
            "active": 1
        },
        {
            "id": "11ead7f68d2c5a228a6bc8d8",
            "title": "new Title",
            "location_id": "11111111-1111-1111-1111-111111111111",
            "serial_number": "123456",
            "scanner_model_id": 4,
            "created_ts": 1596726451,
            "created_user_id": "11111111-1111-1111-1111-111111111111",
            "modified_ts": 1596727300,
            "modified_user_id": "11111111-1111-1111-1111-111111111111",
            "active": 1
        }
    ],
    "meta": {
        "pagination": {
            "links": {
                "self": {
                    "href": "http://192.168.1.204/site/api/web/v2/scanners?page=1"
                }
            },
            "totalCount": 2,
            "pageCount": 1,
            "currentPage": 0,
            "perPage": 20
        },
        "sort": {
            "attributes": {
                "created_ts": "desc"
            }
        }
    }
}

Delete Record

DELETE /v2/scanners/{id}

{
    // Empty Payload - Nothing Needed Here
}

Conditional JSON Response on HTTP Response Code:

204 - Success, Note was deleted.
409 - Fail, validation error in JSON.