Updates a user profile with new language and time zone settings.

Availability

Breeze 4

Description

Updates a user profile with new language and time zone settings.

Request URL

 http://server_name/api/xml 
     ?action=acl-preference-update 
     &acl-id=integer 
     &lang=allowedValue 
     &time-zone-id=allowedValue 
     &session=BreezeSessionCookieValue

Parameters

Name

Type

Required

Description

acl-id

BIGINT

Y

The ID of the user whose preferences will be updated. Can be a valid principal-id.

lang

Allowed value

N

An abbreviation for the new language (see lang for valid values).

time-zone-id

Allowed value

N

An integer setting for the new time zone (see time-zone-id for values).

session

String

N

The value of the BREEZESESSION cookie. Use this parameter if you do not use a client-side cookie management library.

Filters

Results cannot be filtered or sorted.

Response structure

 <?xml version="1.0" encoding="utf-8" ?> 
 <results> 
 <status code=allowedValue /> 
 </results>

Response values

Element

Attribute

Type

Description

results

Container

All results the action returns.

status

Empty, with attributes

The status of the response.

code

Allowed value

A code indicating the response status (see status).

Sample request

 https://server.com/api/xml?action=acl-preference-update&acl-id=12345 
         &lang=fr&time-zone-id=0

Sample response

 <?xml version="1.0" encoding="utf-8" ?> 
 <results> 
     <status code="ok" />  
 </results>

This work is licensed under a Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License  Twitter™ and Facebook posts are not covered under the terms of Creative Commons.

Legal Notices   |   Online Privacy Policy