|
|
|
|
|
|
Parameters |
|
Description |
Passed |
Returned |
Method returns list of attributes with details registered in PBA. |
1 |
10 |
Syntax
ListResult BM::AttrTypeListGet_API(
Int SortNo.
)
returns
Str AttributeID - ID of attribute;
Str Name - attribute name;
Str Description - attribute description;
Str Type - attribute value type. INT - integer, STR - text up to 80 characters, STRA - text over 80 characters, DATE - date, PASSWD - password, NAME_LOGIN - login name, DOMAIN_NAME - domain name;
Str Group - attribute group name. Attributes with the same group displayed in online store under group name;
Int Status - defines whether attribute is optional - 10, or required - 20;
Int AfterField - defines where the attribute should be located among other data fields which a customer has to fill in: 1 - Address Line 1, 2 - Address Line 2, 3 - City, 4 - Country, 5 - Email Address, 6 - Phone, 7 - Fax, 8 - First Name, 9 - Last Name, 10 - Company, 11 - Postal address, 12 - Tax, 13 - State/Province, 14 - Zip code, 15 - Login;
Int AttributeType - defines attribute type: 0 - available for accounts, 1 - available for users;
Int Active - defines whether attribute is active - 1 or not - 0;
Int SortNumber - attribute sort number. It works together with the After Field option. If a number of attributes have same the After Field parameter value, the parameter defines sort number for them.
Int ShowinStorefront - signifies whether to display an attribute in online store -1 or only on creating account from CP - 0.
Special Notes
Int SortNo - defines how output data is sorted: 1 - the output is sorted by first column in ascending order, 1 - the output is sorted by second column in ascending order, etc. Negative value makes output sorted in descending order, for example: -1 - the output is sorted by first column (Attribute ID) in descending order.