ALalianza
Device (Deprecated)

Retrieve device

Use to retrieve a device, DEPRECATED use /v2/partition/{id}/account/{id}/deviceline/{id} endpoint instead

get/v2/partition/{partitionId}/account/{accountId}/user/{userId}/device/{deviceId}

Request

Path parameters

accountIdstring required

ID of account

deviceIdstring required

DeviceId

partitionIdstring required

ID of partition

userIdstring required

ID of end-user

Response

Successful operation

idstring required

Not required for creating a new device line

deviceTypeIdstring required

Identifies the equipment as well as the features that the device supports. Refers to <a href="#/~schema/DeviceTypeX">deviceType.id</a>. See also: <a href="#/~operation/Reference%20Resources/getDeviceTypes">Get All Device Types</a> and <a href="#/~operation/Reference%20Resources/getDeviceTypeById">Get Device Type by ID</a>

accountIdstring required

Not required for creating a new device line

partitionIdstring required

Not required for creating a new device line

macAddressstring

The 48-bit hexadecimal address assigned to the device by the manufacturer. Required if the device line refers to a physical device. Must not be claimed in another device request.

deviceNamestring required
emergencyNumberstring

Required if emergencyNumberReservationId is absent

emergencyNumberReservationIdstring

Required if emergencyNumber is absent

faxEnabledboolean required
lineNumberinteger required

Required for POST & PUT operations only

userIdstring required
sipPasswordstring
sipUsernamestring

Required to be globally unique if specified

zipcodestring
statestring
lineType'Line' | 'AdvancedSharedLine' | 'ReferencedUser' | 'IntercomLine' | 'PresenceBlfUser' | 'SpeedDialUser' | 'SpeedDialTn' | 'CallParkingSpot' | 'SipPaging' | 'Custom'
referenceIdstring

Changes Depending on LineType. If LineType.Line then this should be null. If LineType.ReferencedUser, PresenceBlfUser, or SpeedDialUser then this should be a valid userid. If LineType.SpeedDialTn then this should be a valid phone number.

Changes

No recorded changes to this operation across all 1 revision of this API.