Jump to

• Request
• Response

Get logged-in device of an employee.

get

/connectedWorker/clientapi/v2/employees/{employeeId}/loggedInDevices/{deviceId}

This operation retrieves device that is associated with an employee.

Request

Path Parameters

• deviceId: string
  Device identifier
• employeeId: string
  Employee identifier

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Logged-in device was successfully retrieved.

Body ()

Root Schema : Discriminator: type

Type: object

{
    "required":[
        "deviceId"
    ],
    "type":"object",
    "properties":{
        "deviceId":{
            "type":"string",
            "description":"Id of the device. The device must be activated and must support device model(s) associated with CW app.",
            "example":"21E15228-0C54-47E6-AC7F-41A0A8F8D10E"
        },
        "type":{
            "type":"string",
            "description":"Type associated with the device",
            "example":"SMART",
            "enum":[
                "SMART",
                "TRACKING",
                "SENSOR",
                "SMART, TRACKING, SENSOR"
            ]
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        },
        "smart":{
            "type":"boolean",
            "description":"Flag to indicating whether the device is smart or not",
            "readOnly":true,
            "example":true
        },
        "id":{
            "type":"string",
            "description":"Id of the device. The device must be activated and must support device model(s) associated with CW app.Deprecated. Use deviceId property.",
            "example":"21E15228-0C54-47E6-AC7F-41A0A8F8D10E"
        }
    },
    "discriminator":{
        "propertyName":"type"
    }
}

Show Source

• deviceId: string
  Id of the device. The device must be activated and must support device model(s) associated with CW app.

  Example: 21E15228-0C54-47E6-AC7F-41A0A8F8D10E
• id(optional): string
  Id of the device. The device must be activated and must support device model(s) associated with CW app.Deprecated. Use deviceId property.

  Example: 21E15228-0C54-47E6-AC7F-41A0A8F8D10E
• links(optional): array links
• smart(optional): boolean
  Read Only: true

  Flag to indicating whether the device is smart or not

  Example: true
• type(optional): string
  Allowed Values: [ "SMART", "TRACKING", "SENSOR", "SMART, TRACKING, SENSOR" ]

  Type associated with the device

  Example: SMART

{
    "required":[
        "deviceId"
    ],
    "type":"object",
    "properties":{
        "deviceId":{
            "type":"string",
            "description":"Id of the device. The device must be activated and must support device model(s) associated with CW app.",
            "example":"21E15228-0C54-47E6-AC7F-41A0A8F8D10E"
        },
        "type":{
            "type":"string",
            "description":"Type associated with the device",
            "example":"SMART",
            "enum":[
                "SMART",
                "TRACKING",
                "SENSOR",
                "SMART, TRACKING, SENSOR"
            ]
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        },
        "smart":{
            "type":"boolean",
            "description":"Flag to indicating whether the device is smart or not",
            "readOnly":true,
            "example":true
        },
        "id":{
            "type":"string",
            "description":"Id of the device. The device must be activated and must support device model(s) associated with CW app.Deprecated. Use deviceId property.",
            "example":"21E15228-0C54-47E6-AC7F-41A0A8F8D10E"
        }
    },
    "discriminator":{
        "propertyName":"type"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : Link

Type: object

Show Source

• href: string
  The target resource's URI
• rel: string
  Relation type

{
    "required":[
        "href",
        "rel"
    ],
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"Relation type"
        },
        "href":{
            "type":"string",
            "description":"The target resource's URI"
        }
    }
}

Back to Top