GET api/UserFields/{id}/Schema

Retrieves schema information for the specified user field.

Request

Parameters

Name Description Default
id Unique user field ID.

Response

Body

Content Type: application/xml
Schema: http://www.w3.org/2001/XMLSchema
XML schema document or an error message.

Status Codes

Code Condition
200 OK The operation completed successfully.
400 Bad RequestInvalid user field ID.
401 Unauthorized Access token is invalid, expired or not specified.
404 Not FoundUser field has no associated schema.
406 Not Acceptable Content type specified in the Accept header isn't supported.
500 Internal Server Error An internal error occurred.

Remarks

Only custom user field types which store their values as XML data are likely to define a schema.