Versions Compared

Old Version 1

changes.mady.by.user Georgia Kountouri

Saved on

compared with

New Version Current

changes.mady.by.user Former user

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Tip

Available from CRM.COM R14.2.0

Excerpt

This method is used to set (or reset) the logged in user's session settings. Any session setting can be modified in each call.

...

Name

Type

Description

token

String

The token retrieved from the login method

language

(optional)

String The session's related language. Only languages which are supported in General Settings can be selected. The available options are:
  • ARA
  • DAN
  • ENG
  • EST
  • FIN
  • FRA
  • DEU
  • ELL
  • JPN
  • VIE
  • MAL
  • IND
  • TAI
  • LAV
  • LIT
  • NNO
  • POL
  • POR
  • RUS
  • SPA
  • SWE
  • UKR
  • CMN
  • TGL
  • HIN
  • CUSTOM1
  • CUSTOM2
  • CUSTOM3
  • CUSTOM4
  • CUSTOM5
  • CUSTOM6
  • CUSTOM7
  • CUSTOM8

regiontimezone

(optional)

StringThe region that is represented by the selected timezone

utc_offset_in_minutes

(optional)

IntegerThe selected timezone offset in relation to UTC in minutessession's time zone. Time Zones are defined as a combination of a UTC offset and DST. The supported options are populated based on the Oslo Time Zone IDs. The default option is UTC

country_identifier

(optional)

Country Identifier

The session's related country. The allowed country identifier fields are the following:

Include Page
V4:country_identifier
V4:country_identifier

currency_identifier

(optional)

Currency Identifier

The session's related currency. The allowed currency identifier fields are the following:

Include Page
V4:currency_identifier
V4:currency_identifier

fields_set
(optional)

List of Strings, comma separated 

A list of fields that should be included in the results. If not specified then all the available fields will be returned

...

Expand
titleExample 1

HTTP Method: POST

 

Request:

Body:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 {
 	"token":"{{token}}",
	"language":"ENG",
 	"timezone":"UTC",
 	"country_identifier": {"name":"CYPRUS"},
 	"currency_identifier": {"code":"EUR"}
}

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 {
    "data": {
        "country": {
            "alternative_code": "CYP",
            "three_character_code": "CYP",
            "name": "CYPRUS",
            "id": "181",
            "two_character_code": "CY"
        },
        "language": {
            "language": "ENG"
        },
        "currency": {
            "suffix_symbol": "N/A",
            "prefix_symbol": "€",
            "decimal_part_name": "cents",
            "code": "EUR",
            "integer_part_name": "euro",
            "id": "2",
            "life_cycle_state": "EFFECTIVE"
        },
        "time_zone": {
            "utc_offset_in_minutes": 0,
            "region": "UTC"
        }
    },
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}