member data
API Support | Available since | Last updated | Output |
---|---|---|---|
5.9900 | 5.9900 | xml, json, * |
Description
The behaviour and URL of this service is not consistent with other services, please read the description carefully.
Retrieves personal member data and can be accessed through the following URL:
/ps/api/member-data/{memberid}/data/{name}
Or
/ps/servlet/members/{memberid}/data/{name}
Where name
can contain lowercase letters, numbers, hyphen or underscore and can have an optional alphanumeric extension after a dot which is ignored, for example public-picture.png
.
Parameters
No parameters required.
We recommend that you always use entity tags when making a request to this service using If-None-Match HTTP
header.
Permission
Only the member themselves or an administrator can get the member data, unless the data name is prefixed by public-
, in which case it is available publicly.
For example, anyone can see the public-picture.png
Response
Returns the member data.
The media type is returned in the Content-Type HTTP header and is one of the allowed media types. JSON and XML response are always encoded using utf-8.
The Cache-Control HTTP header is public, max-age=0
for public member data and private, max-age=0
otherwise.
The HTTP 200 response always includes the Etag and Last-Modified HTTP headers. To detect and prevent collisions, use the entity tag to make any PUT or DELETE request on member data.
Error handling
Code | Cause / Description |
---|---|
0x102D | No member data found |
0x1030 | Member data name does not match [name].[extension] |
0x1030 | Member data name is too long (max 200 characters) |