Get Account Preferences

Retrieve the preferences of the currently logged-in account.

Request URL

GET {base_url}/uc-user/api/v1/preferences/me

Request parameters

Headers
Parameter Required Type Description
Authorization Yes String The access token used for authentication.

Format: Bearer {access_token}.

Response parameters

Parameter Type Description
requestId String The unique ID of the request, which can be used to quickly locate the request.
code String The HTTP status code of the request.
  • 200: Request succeeded.
  • Non-200 value: Request failed.
message String The status message of the request.
detailMessage String The detailed error information.

When the request is successful, this parameter returns empty.
result Object<Preferences> The preferences of the current user.
Preferences
Parameter Type Description
nameDisplayFormat String The format used to display names.
  • fls: First Name Last Name with Space Inbetween
  • lfs: Last Name First Name with Space Inbetween
  • lf: Last Name First Name without Space Inbetween
dateDisplayFormat String The date display format.
  • yyyy/mm/dd: Year/Month/Day
  • mm/dd/yyyy: Month/Day/Year
  • dd/mm/yyyy: Day/Month/Year
timeDisplayFormat String The time display format.
  • hh:mm:ss A: 12-hour format.
  • HH:mm:ss: 24-hour format.
systemLanguage String The web interface language.

Example

Request example

GET /uc-user/api/v1/preferences/me HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc5MDY4ODkzMSwiaWF0IjoxNzkwNjY3MzMxLCJqdGkiOiJiOTNlNTU3MC00ZmFiLTQ2ZGYtYTUwNi1jMmJkMGEzYjNjMmYiLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.0yI_AGvYv443s_inqLFA3mEnCG7_2acIE3ELkczpg4OoMYSL7jzlmHh3YkP-HXa6vNzsz0O2Y_jtFawZZ34fRyofyYQ2siauKPWC1bpp8fv4VBOB9h1MNbNMCGH0ZSVDcBHaUo_MJJhWGCH0Na-KE287Gjiz-Q22IOGy6ouCYqA8ArAFQ8ZdbD1e3P4-pGHqEJi8U0GjcECPe8HaJZ7b97BcwzpXI9xCAR-1LOXeYv0dYsnnVCsL3C1cOP9QGIozgPTbotMuk_NNrpuGFlkDeRD67vudzUv30485MEvoybuzMgfsIsj5bRL2GbT-DF7Eubs_KYcdxziXSroFgMsEXQ

Response example

HTTP/1.1 200 OK
{
  "result": {
    "nameDisplayFormat": "fls",
    "dateDisplayFormat": "yyyy/mm/dd",
    "timeDisplayFormat": "HH:mm:ss",
    "systemLanguage": "en"
  },
  "requestId": "d67c9a09cf7fa85f181f82f816a44591",
  "code": "200",
  "message": "SUCCESS"
}