Meta Data API
In the Atlato Store, User Metadata Overview
Definitions
| Metadata | Definition | Data Types |
|---|---|---|
| message | A status string that indicates the success of the API request. In this example, "Meta data retrieved successfully" confirms that the user metadata was fetched successfully. | |
| data | This is an object containing various fields that describe the user's details and associated company information. | |
The email address of the user ("demo@company.com"), used for communication and login purposes. Using data type format is (String). | ||
| userId | A unique identifier for the user (1), essential for user management and referencing within the system. Using data type format is (Number). | |
| username | The display name of the user ("Demo User"), typically used for identification in the user interface. Using data type format is (String). | |
| profilePicture | The filename of the user's profile picture ("profile.jpg"), which can be used to load and display the user's image in the application. Using data type file format is (JPG, GIF or PNG). | |
| accessRights | An array that lists the user's permissions or roles within the application. In this case, it’s empty, indicating no specific access rights are defined. Using data type format is (Number). | |
| company | An object containing details about the user's associated company. Using data type format is (String). | |
| id | The unique identifier for the company (Company Id). Using data type format is (Number). | |
| name | The name of the company ("Demo Company"). Using data type format is (String). | |
| countryId | The identifier for the country where the company is located (18). Using data type format is (Number). | |
| companyUnit | An object that specifies various settings for the company. In this object array have timeFormat , unitOfMeasurement , dateFormat , currencyId , currencyCode , timeZone | |
| timeFormat | The preferred time format setting (1), which could indicate a specific format like 12-hour or 24-hour. Using data type format is (Number). | |
| unitOfMeasurement | The preferred unit of measurement (1), likely corresponding to metric or imperial units. Using data type format is (Number). | 1 - Metric units 2- Imperial units |
| dateFormat | The preferred date format (1), indicating the format in which dates should be displayed. Using data type format is (Number). | 1 - YYYY/MM/DD, 2 - DD/MM/YYYY, 3 - MM/DD/YYYY |
| currencyId | The identifier of the currency used by the company (2). Using data type format is (Number). | AUD , LKR |
| currencyCode | The currency code ("AUD , LKR"), indicating the company's preferred currency. Using data type format is (String). | AUD , LKR |
| timeZone | The time zone offset ("-600"), representing the company's local time zone. Using data type format is (Number). | |
| isActive | A boolean value (true, False) that indicates whether the company is currently active. Using data type format is (Boolean). | |
| isAdmin | An integer (1) indicating whether the user has administrative privileges. Using data type format is (Number). | |
| mobileNumber | The user's mobile phone number (+94 xx xxx xxxx ), used for contact purposes. Using data type format is (Number). | |
| role | The user's role within the company ("Administrator"), which defines their responsibilities and access levels. |
Modified at 2024-09-29 18:00:59