Library OpenApi Overview About these APIs Architecture Authentication Error Responses Locating a Server Sessions Design Guides Guides and Hints Examples Pricing for Websites Accepting Vouchers PreAuth Payment Replication Common Apis The most used APIs Create New Sale Payment Completion Multiple Locations Delivery Addresses Create New Sale v2 Customers Locations Products Staff WebHooks eCommerce Apis These APIs are often used with eCommerce website integrations Get Pricing Card Inquiry Report & Analysis Grouped or analysed report data. Typically used to build reports and dashboards Today Login Access Pinboard ReportRequest Advanced Information More indepth information Caller Handling HTTP Protocol Bulk Data Downloads Document Uploading RetailConfig Under Development Details of APIs that will be available shortly. Documentation provided is for early adopters Get Receipt

Staff API

Simple Examples

Storing details of a new staff member

{
    "Name": "Pat Benatar"
}

Using /Staff/{Key} API

While the /Staff/{Key} API is commonly used to retrieve a single staff member record by internal ID# (aka Tid) it can also return a single staff member details when searching by other criteria.

/Staff/barcode=1343536
Returns a single staff member with the barcode 1343536
/Staff/tid=1234
/Staff/name=John
/Staff/nameformal=John Smith
/Staff/nameprinted=John23
/Staff/physkey=ABFHEJKEFJJVHW56GJSI221BNEJ
/Staff/autologinfromwindowsname=john@example.com
/Staff/externalid=PEEPS456JOHN

Each of the above will only return a single record. However, this may change in a future release to retrun all matching records. Currently, if multiple records match then no records will be returned.

Retrieving Security Rights and Roles

To retrieve additional fields not provided by default you add the query parameter ?want=... and the requested information will be included in the response.

/Staff/12345?want=200
Include the Security roles held by this staff member 
{
  "data": {
    "Staff": [
      {
        "Tid": 7,
        "Name": "Bhupinder",
        "Active": 0,
        "MainLocation": null,
        "NamePrinted": null,
        "StartDt": null,
        "LeaveDt": null,
        "Physkey": null,
        "RemoteProfile": null,
        "AutoLoginFromWindowsName": null,
        "LoginBitmask": null,
        "ExternalId": null,
        "WorkLocation": null,
        "SecurityRole": "MANAGER"
      }
    ]
  }
}
/Staff/12345?want=203
Return full security right and role information, including where rights are derived from 
{
  "data": {
    "Staff": [
      {
        "Tid": 7,
        "Name": "Bhupinder",
        "Active": 0,
        "MainLocation": null,
        "NamePrinted": null,
        "StartDt": null,
        "LeaveDt": null,
        "Physkey": null,
        "RemoteProfile": null,
        "AutoLoginFromWindowsName": null,
        "LoginBitmask": null,
        "ExternalId": null,
        "WorkLocation": null,
        
            "RIGH": [
            {
                "RoleId": 7,
                "ROLE": [
                    {
                        "RoleId": -101,
                        "Name": "MANAGER"
                    }
                ]
            },
            {
                "RoleId": -101,
                "SecurityRight": [
                    1001,
                    1006,
                    2000,
                    983042,
                    983043,
                    983044
                ]
            }
            ]
        
      }
    ]
  }
}