ALalianza
Account Device Line

Retrieve device line list

Use to retrieve a list of device lines associated to an account. If the parameters filter and filterType are not set, the returned devices list will include either all of the device lines for the referred account, in case the acting user is an Account User, or the devices owned by the acting user only, otherwise. <span hidden>See more about <a href="accountDeviceLine.html">Account Device Lines</a> and <a href="accountUser.html">Account User</a>.</span>

get/v2/partition/{partitionId}/account/{accountId}/deviceline

Request

Path parameters

accountIdstring required

ID of account, refers to <a href="#/~schema/Account">account.id</a>

partitionIdstring required

ID of partition, refers to <a href="#/~schema/PartitionX">partition.id</a>

Query parameters

filterstring

Required when filterType is set, used to return specific devices on the account.

filterType'MAC_ADDRESS' | 'MAC_ADDRESS_INVENTORY' | 'OWNING_USERID' | 'REFERENCED_USERID' | 'ACCOUNT'

Used in conjunction with filter to return specific devices on the account. If set to REFERENCED_USERID and the acting user is an End User, then the filter must be set to the End User ID or else a NotPermitted error will be returned.

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.