Attribute

The DLS API Attribute class is the API view onto XML items which are used by DLS to communicate with devices. Such an attribute therefore always has a name and a value, which are both represented by strings.

But although the attribute values are given by strings, they must conform to a special format depending on the DLS internal attribute type.

The table below lists all possible DLS internal types together with a description of the format their respective value strings have to confirm to. E.g. an attribute value of type "is_Boolen" must be one of "0", "1", "false" or "true".

Note that attribute values must never be "null". To unset an attribute to no value always the empty string value should be used.

Attribute types

DLS typeDescription
is_StringAny WSDL string.
is_Bool"0" or "false" represents a 'false' boolean value, "1" or "true" represents a 'true' boolean value. Other values are not permitted.
is_NumberDenotes a non-negative number.The characters in the string must all be decimal digits. Leading '0's are allowed.
is_TimeDenotes the number of milliseconds since January 1, 1970, 00:00:00 GMT. The value sould therefore be a number with the excpetion that a minus sign '-' is allowed as first character.
is_Date_TimeFrom the inrerface point of view the same as "is_Time".
is_CodedA enumeration of strings. Each attribute of type "is_Coded" contains in its description the enumeration of possible sting values.
is_PasswordFrom the inrerface point of view the same as "is_String".
is_Numeric_PasswordThe characters in the string must all be decimal digits, and the string must not be empty.
is_Dialplan_Digit_StringThe characters in the string must all be decimal digits, or one of the characters '*', '#' or 'x'.
is_Dialplan_Digit_IdThe value string has to start with a '!' and can be followed by any character
is_E164The characters in the string must all be decimal digits, or one of the characters '*' or '#', and the string must not be empty.
is_Domain_NameMust match the following regular-expression pattern: [0-9A-Za-z._\-]*
is_IP_AdressMust have the form "a.b.c.d", where 'a' through 'd' are non-negative integers nor exceeding 255. Leading zeros are permitted as long as the length of 'a' through 'd' is not larger than 3.
is_Repertory_KeyMust match the following regular-expression pattern: ([0-9*#]*(\\$[QRST])*)*
is_Key_DestMust be of type "is_E164" or "is_Domian_Name" or "is_IP_Address" or "is_Repertory_Key".
is_MAC_AddressMust match the following regular-expression pattern: (\\p{XDigit}{2}[:-]){5}\\p{XDigit}{2}
is_signed_NumberThe characters in the string must all be decimal digits, except that the first character may be an ASCII minus sign '-' ('\u002D') to indicate a negative value.
is_Subnet_MaskMust be of type 'is_IP_Address', where each block 'a' throug 'd' is contained in the set {0, 128, 192, 224, 240, 248, 252, 254 , 255}.
is_URLFor URL format definition see rfc2396