Vridlo/types/Recital: Difference between revisions
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
'''Recital''' is a structure that represents Recital model. It is described as: | '''Recital''' is a structure that represents Recital model. It is described as: | ||
* ''' | * '''account_id''' is ''string '''mandatory read-only internal''''' | ||
Number identifier of the account. | |||
* '''text''' is ''string '''mandatory''''' | * '''text''' is ''string '''mandatory''''' | ||
Unique name scription for the specific ICU Locale. It can include first name, last name, nickname, or title. | Unique name scription for the specific ICU Locale. It can include first name, last name, nickname, or title. | ||
* '''kind''' is ''string '''mandatory''''' | * '''kind''' is ''string '''mandatory''''' | ||
Type of name for the specific ICU Locale. Can be one of ''email'', ''login'', ''jabber'', ''website'', ''location'' | Type of name for the specific ICU Locale. Can be one of ''email'', ''login'', ''jabber'', ''website'', ''location''. | ||
* '''uri''' is ''string '''optional''''' | * '''uri''' is ''string '''optional''''' | ||
URI belonged to the user, is set if '''kind''' is ''website''. | URI belonged to the user, is set if '''kind''' is ''website''. | ||
* '''mailto''' is ''string '''optional''''' | * '''mailto''' is ''string '''optional''''' | ||
Mailto address of the user, is set if '''kind''' is ''email''. | Mailto address of the user, is set if '''kind''' is ''email''. | ||
* '''slug''' is ''string '''optional''''' | * '''slug''' is ''string '''optional''''' | ||
Login slug of the user, is set if '''kind''' is ''login''. | Login slug of the user, is set if '''kind''' is ''login''. | ||
* '''address''' is ''string '''optional''''' | * '''address''' is ''string '''optional''''' | ||
Location address of user, is set if '''kind''' is ''location''. It contains the [[Vridlo/types/Location|Location]] record. | Location address of user, is set if '''kind''' is ''location''. It contains the [[Vridlo/types/Location|Location]] record. | ||
* '''foremost''' is ''boolean '''optional''''' | * '''foremost''' is ''boolean '''optional''''' | ||
Is the recital the foremost for the user or not. Default for firstly added recital is ''true'', otherwise ''false'' | Is the recital the foremost for the user or not. Default for firstly added recital is ''true'', otherwise ''false''. | ||
Revision as of 17:29, 12 December 2019
Recital is a structure that represents Recital model. It is described as:
- account_id is string mandatory read-only internal
Number identifier of the account.
- text is string mandatory
Unique name scription for the specific ICU Locale. It can include first name, last name, nickname, or title.
- kind is string mandatory
Type of name for the specific ICU Locale. Can be one of email, login, jabber, website, location.
- uri is string optional
URI belonged to the user, is set if kind is website.
- mailto is string optional
Mailto address of the user, is set if kind is email.
- slug is string optional
Login slug of the user, is set if kind is login.
- address is string optional
Location address of user, is set if kind is location. It contains the Location record.
- foremost is boolean optional
Is the recital the foremost for the user or not. Default for firstly added recital is true, otherwise false.