SearchResultEmployeeResult resource

Methods

  • get - Search Employees

Resource

{
    "limit": "int32",
    "skip": "int32",
    "total": "int64",
    "values": [
        {
            "address": {
                "address": "string",
                "addressLine2": "string",
                "city": "string",
                "companyId": "string",
                "country": "string",
                "created": "int64",
                "deleted": "boolean",
                "id": "string",
                "latitude": "number",
                "longitude": "number",
                "modified": "int64",
                "state": "string",
                "updated": "boolean",
                "zipCode": "string"
            },
            "appAccessList": [
                "string"
            ],
            "assignedInventoryId": "string",
            "assignedTerminalId": "string",
            "canApplyCustomDiscount": "boolean",
            "cashDrawerStatus": "string",
            "companyId": "string",
            "created": "int64",
            "deleted": "boolean",
            "disabled": "boolean",
            "dlExpirationDate": "string",
            "driver": "boolean",
            "driversLicense": "string",
            "email": "string",
            "employeeOnFleetInfoList": [
                {
                    "onFleetTeamList": [
                        "string"
                    ],
                    "onFleetWorkerId": "string",
                    "shopId": "string"
                }
            ],
            "employeeOnFleetInfoResults": [
                {
                    "employeeOnFleetTeams": {
                        "<key>": "string"
                    },
                    "onFleetTeamList": [
                        "string"
                    ],
                    "onFleetWorkerId": "string",
                    "shopId": "string",
                    "shopName": "string"
                }
            ],
            "externalId": "string",
            "firstName": "string",
            "id": "string",
            "insuranceCompanyName": "string",
            "insuranceExpireDate": "int64",
            "inventoryName": "string",
            "lastLoggedInShopId": "string",
            "lastLoginTime": "int64",
            "lastName": "string",
            "modified": "int64",
            "notes": [
                {
                    "created": "int64",
                    "deleted": "boolean",
                    "enableOnFleet": "boolean",
                    "id": "string",
                    "message": "string",
                    "modified": "int64",
                    "updated": "boolean",
                    "writerId": "string",
                    "writerName": "string"
                }
            ],
            "occupationLicenseNumber": "string",
            "organizationIds": [
                "string"
            ],
            "password": "string",
            "phoneNumber": "string",
            "pin": "string",
            "policyNumber": "string",
            "recentLocation": {
                "companyId": "string",
                "created": "int64",
                "deleted": "boolean",
                "deviceId": "string",
                "dirty": "boolean",
                "employeeId": "string",
                "id": "string",
                "loc": [
                    "double"
                ],
                "modified": "int64",
                "name": "string",
                "shopId": "string",
                "terminalId": "string",
                "timeCardId": "string",
                "updated": "boolean"
            },
            "registrationExpireDate": "int64",
            "role": {
                "companyId": "string",
                "created": "int64",
                "deleted": "boolean",
                "id": "string",
                "modified": "int64",
                "name": "string",
                "permissions": [
                    "string"
                ],
                "updated": "boolean"
            },
            "roleId": "string",
            "shops": [
                "string"
            ],
            "terminalName": "string",
            "timeCard": {
                "clockInTime": "int64",
                "clockOutTime": "int64",
                "clockin": "boolean",
                "companyId": "string",
                "created": "int64",
                "deleted": "boolean",
                "dirty": "boolean",
                "employeeId": "string",
                "id": "string",
                "modified": "int64",
                "sessions": [
                    {
                        "companyId": "string",
                        "created": "int64",
                        "deleted": "boolean",
                        "dirty": "boolean",
                        "employeeId": "string",
                        "endTime": "int64",
                        "id": "string",
                        "modified": "int64",
                        "shopId": "string",
                        "startTime": "int64",
                        "terminalId": "string",
                        "timeCardId": "string",
                        "updated": "boolean"
                    }
                ],
                "shopId": "string",
                "updated": "boolean"
            },
            "timecardId": "string",
            "tookanInfoList": [
                {
                    "shopId": "string",
                    "status": "string",
                    "teamId": "string",
                    "tookanAgentId": "string"
                }
            ],
            "updated": "boolean",
            "vehicleLicensePlate": "string",
            "vehicleMake": "string",
            "vehicleModel": "string",
            "vehiclePin": "string",
            "vinNo": "string"
        }
    ]
}

Properties

Name Type Description Additional
limit int32 Optional
skip int32 Optional
total int64 Optional
values[] array Optional
values[].address object Address Optional
values[].address.address string Optional
values[].address.addressLine2 string Optional
values[].address.city string Optional
values[].address.companyId string Optional
values[].address.country string Optional
values[].address.created int64 Optional
values[].address.deleted boolean Optional
values[].address.id string Optional
values[].address.latitude number Optional
values[].address.longitude number Optional
values[].address.modified int64 Optional
values[].address.state string Optional
values[].address.updated boolean Optional
values[].address.zipCode string Optional
values[].appAccessList[] array of string

Possible values are:

  • AuthenticationApp
  • Retail
  • Distribution
  • Grow
  • Dispatch
 Optional
values[].assignedInventoryId string Optional
values[].assignedTerminalId string Optional
values[].canApplyCustomDiscount boolean Optional
values[].cashDrawerStatus string

Possible values are:

  • Open
  • Closed
 Optional
values[].companyId string Optional
values[].created int64 Optional
values[].deleted boolean Optional
values[].disabled boolean Optional
values[].dlExpirationDate string Optional
values[].driver boolean Optional
values[].driversLicense string Optional
values[].email string Optional
values[].employeeOnFleetInfoList[] array Optional
values[].employeeOnFleetInfoList[].onFleetTeamList[] array of string Optional
values[].employeeOnFleetInfoList[].onFleetWorkerId string Optional
values[].employeeOnFleetInfoList[].shopId string Optional
values[].employeeOnFleetInfoResults[] array Optional
values[].employeeOnFleetInfoResults[].employeeOnFleetTeams object Optional
values[].employeeOnFleetInfoResults[].employeeOnFleetTeams.<key> map of string Optional
values[].employeeOnFleetInfoResults[].onFleetTeamList[] array of string Optional
values[].employeeOnFleetInfoResults[].onFleetWorkerId string Optional
values[].employeeOnFleetInfoResults[].shopId string Optional
values[].employeeOnFleetInfoResults[].shopName string Optional
values[].externalId string Optional
values[].firstName string Optional
values[].id string Optional
values[].insuranceCompanyName string Optional
values[].insuranceExpireDate int64 Optional
values[].inventoryName string Optional
values[].lastLoggedInShopId string Optional
values[].lastLoginTime int64 Optional
values[].lastName string Optional
values[].modified int64 Optional
values[].notes[] array Optional
values[].notes[].created int64 Optional
values[].notes[].deleted boolean Optional
values[].notes[].enableOnFleet boolean Optional
values[].notes[].id string Optional
values[].notes[].message string Optional
values[].notes[].modified int64 Optional
values[].notes[].updated boolean Optional
values[].notes[].writerId string Optional
values[].notes[].writerName string Optional
values[].occupationLicenseNumber string Optional
values[].organizationIds[] array of string Optional
values[].password string Optional
values[].phoneNumber string Optional
values[].pin string Optional
values[].policyNumber string Optional
values[].recentLocation object TerminalLocation Optional
values[].recentLocation.companyId string Optional
values[].recentLocation.created int64 Optional
values[].recentLocation.deleted boolean Optional
values[].recentLocation.deviceId string Optional
values[].recentLocation.dirty boolean Optional
values[].recentLocation.employeeId string Optional
values[].recentLocation.id string Optional
values[].recentLocation.loc[] array of double Optional
values[].recentLocation.modified int64 Optional
values[].recentLocation.name string Optional
values[].recentLocation.shopId string Optional
values[].recentLocation.terminalId string Optional
values[].recentLocation.timeCardId string Optional
values[].recentLocation.updated boolean Optional
values[].registrationExpireDate int64 Optional
values[].role object Role Optional
values[].role.companyId string Optional
values[].role.created int64 Optional
values[].role.deleted boolean Optional
values[].role.id string Optional
values[].role.modified int64 Optional
values[].role.name string Optional
values[].role.permissions[] array of string

Possible values are:

  • None
  • iPadMemberAdd
  • iPadMemberEdit
  • iPadQueueAddMember
  • iPadTransactionsViews
  • iPadProcessSales
  • iPadRefund
  • iPadApplyCartDiscounts
  • iPadApplyLineItemDiscounts
  • iPadApplyCoupons
  • iPadCashDrawerOpen
  • iPadCashDrawerCloseOut
  • iPadTransactionsLookup
  • iPadInitiation
  • iPadQuickPinLogin
  • iPadManageSettingsView
  • iPadManagerSettingsManage
  • WebAdminLogin
  • WebAllMembersView
  • WebMembersView
  • WebMembersManage
  • WebMembersAddToQueue
  • WebPromotionsView
  • WebPromotionsManage
  • WebTransactionsView
  • WebTransactionsRefund
  • WebInventoryView
  • WebInventoryManage
  • WebInventoryTransfer
  • WebInventoryCategoryManage
  • WebEmployeeView
  • WebEmployeeManage
  • WebEmployeeClockout
  • WebVendorView
  • WebVendorManage
  • WebSettingsView
  • WebSettingsManage
  • WebPhysiciansView
  • WebPhysiciansManage
  • WebReportsView
  • WebDeliveryView
  • WebCashDrawerView
  • WebUnlockOrder
  • WebEditBatch
  • WebAddBatch
  • WebInvoiceView
  • WebInvoiceManage
  • WebInventoryReconciliation
  • WebDashboardView
  • WebPurchaseOrderView
  • WebPurchaseOrderManage
  • WebExpenseView
  • WebExpenseManage
  • WebQuickBookManage
  • WebInvoiceManifestChange
  • WebEditPosPayment
  • WebTransactionsVoid
  • WebCancelPosOrders
 Optional
values[].role.updated boolean Optional
values[].roleId string Optional
values[].shops[] array of string Optional
values[].terminalName string Optional
values[].timeCard object TimeCard Optional
values[].timeCard.clockInTime int64 Optional
values[].timeCard.clockOutTime int64 Optional
values[].timeCard.clockin boolean Optional
values[].timeCard.companyId string Optional
values[].timeCard.created int64 Optional
values[].timeCard.deleted boolean Optional
values[].timeCard.dirty boolean Optional
values[].timeCard.employeeId string Optional
values[].timeCard.id string Optional
values[].timeCard.modified int64 Optional
values[].timeCard.sessions[] array Optional
values[].timeCard.sessions[].companyId string Optional
values[].timeCard.sessions[].created int64 Optional
values[].timeCard.sessions[].deleted boolean Optional
values[].timeCard.sessions[].dirty boolean Optional
values[].timeCard.sessions[].employeeId string Optional
values[].timeCard.sessions[].endTime int64 Optional
values[].timeCard.sessions[].id string Optional
values[].timeCard.sessions[].modified int64 Optional
values[].timeCard.sessions[].shopId string Optional
values[].timeCard.sessions[].startTime int64 Optional
values[].timeCard.sessions[].terminalId string Optional
values[].timeCard.sessions[].timeCardId string Optional
values[].timeCard.sessions[].updated boolean Optional
values[].timeCard.shopId string Optional
values[].timeCard.updated boolean Optional
values[].timecardId string Optional
values[].tookanInfoList[] array Optional
values[].tookanInfoList[].shopId string Optional
values[].tookanInfoList[].status string

Possible values are:

  • AVAILABLE
  • OFFLINE
  • BUSY
 Optional
values[].tookanInfoList[].teamId string Optional
values[].tookanInfoList[].tookanAgentId string Optional
values[].updated boolean Optional
values[].vehicleLicensePlate string Optional
values[].vehicleMake string Optional
values[].vehicleModel string Optional
values[].vehiclePin string Optional
values[].vinNo string Optional