Get user location history

GET 
/api/web/v1/users/:userid/userlocations

Get the location history of the specified user. Caller requires the USERRBASETTINGS:VIEW permission.

Request

Path Parameters

userid stringrequired

The UUID of the user whose location history is to be retrieved.

Responses

200

Successful

application/json

Schema

Schema

• Array [

city string

The city name--always returned in upper-case.

countryCode string

A two-character (alpha-2) ISO 3166-1 country code.

expiryDate date-time

The date this user location will expire.

id stringrequired

The UUID of the user location.

ipAddress string

The IPv4 Address.

isp string

The ISP name--always returned in upper-case.

lastAuthenticationTime date-timerequired

The time of the last authentication from this location.

latitude float

The latitude.

longitude float

The longitude.

numberOfAuthentications int32required

The number of times this location was used during authentication.

privateIpAddress boolean

Whether the IP provided is a private IP Address.

• ]

Example (from schema)

[
  {
    "city": "string",
    "countryCode": "string",
    "expiryDate": "2019-02-19T13:15:27Z",
    "id": "string",
    "ipAddress": "string",
    "isp": "string",
    "lastAuthenticationTime": "2019-02-19T13:15:27Z",
    "latitude": 0,
    "longitude": 0,
    "numberOfAuthentications": 0,
    "privateIpAddress": true
  }
]

400

Bad Request

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

401

Access denied

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

403

Forbidden

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

404

Not Found

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

409

Conflict

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

Loading...