ProfileField

ProfileField Service

Web service endpoints for providing metadata about user profile.

Since: 3.13

Create Profile Field

POST /admin/profileFields

Create a new profile field with specified characteristics, and return an entity representing the newly created profile field.

Query Parameters:
NameTypeRequiredDescription
fieldsStringfalseFields to include in the returned entity
Takes:
  • ProfileField describing the profile field to be created
    • Retrieves:
  • ProfileField representing the newly created profile field
    • Return Status:
    HTTP Status CodeDescription
    201 (Created)Request was successful
    400 (Bad Request)An input field is malformed
    409 (Conflict)The new profile field would conflict with system restrictions (such as two profile fields with the same name)
    403 (Forbidden)You are not allowed to perform this operation

    Destroy Profile Field

    DELETE /admin/profileFields/{profileFieldID}

    Delete the specified profile field.

    Path Parameters:
    NameTypeRequiredDescription
    profileFieldIDStringtrueID of the profile field to be deleted
    Return Status:
    HTTP Status CodeDescription
    204 (No Content)Request was successful
    400 (Bad Request)An input field is malformed
    403 (Forbidden)You are not allowed to access the specified place
    404 (Not Found)The specified place does not exist

    Get Profile Field

    GET /admin/profileFields/{profileFieldID}

    Return the specified profile field with the specified fields.

    Path Parameters:
    NameTypeRequiredDescription
    profileFieldIDStringtrueID of the profile field to be returned
    Query Parameters:
    NameTypeRequiredDescription
    fieldsStringfalseFields to be returned
    Retrieves:
  • ProfileField
    • Return Status:
    HTTP Status CodeDescription
    200 (OK)Request was successful
    400 (Bad Request)An input field is malformed
    404 (Not Found)The specified profile field does not exist

    Get Profile Field Name

    GET /admin/profileFields/@name

    Return the name profile field with the specified fields.

    Query Parameters:
    NameTypeRequiredDescription
    fieldsStringfalseFields to be returned
    Retrieves:
  • ProfileField
    • Return Status:
    HTTP Status CodeDescription
    200 (OK)Request was successful
    Since: 3.14

    Get Profile Fields

    GET /admin/profileFields

    Return a paginated list of profile fields. The list will include profile fields that can be updated, deleted or are read-only.

    Query Parameters:
    NameTypeRequiredDescription
    startIndexIntegerfalseZero-relative index of the first matching profile field to be returned
    countIntegerfalseMaximum number of profile fields to be returned
    fieldsStringfalseFields to be returned on each profile field
    Retrieves:
  • ProfileField[] listing the matching profile fields
    • Return Status:
    HTTP Status CodeDescription
    200 (OK)Request was successful
    400 (Bad Request)An input field is malformed

    Update Order

    PUT /admin/profileFields/order

    Update the order in which the profile fields should appear in the UI. The received JSON array must contain the URI of all profile fields. The order of the elements in the array determine the order in which the profile fields should appear in the UI.

    Takes:
  • URI of the profile fields.
    • Return Status:
    HTTP Status CodeDescription
    200 (OK)Request was successful
    400 (Bad Request)An input field is malformed
    403 (Forbidden)You are not allowed to perform this operation
    404 (Not Found)One or more of the specified profile fields do not exist

    Update Profile Field

    PUT /admin/profileFields/{profileFieldID}

    Update an existing profile field with specified characteristics.

    Path Parameters:
    NameTypeRequiredDescription
    profileFieldIDStringtrueID of the profile field to be updated
    Query Parameters:
    NameTypeRequiredDescription
    fieldsStringfalseFields to include in the returned entity
    Takes:
  • ProfileField describing the profile field to be updated
    • Retrieves:
  • ProfileField representing the updated profile field
    • Return Status:
    HTTP Status CodeDescription
    400 (Bad Request)An input field is malformed
    403 (Forbidden)You are not allowed to access the specified profile field or to make the requested change
    404 (Not Found)The specified profile field does not exist

    Update Profile Field NAme

    PUT /admin/profileFields/@name

    Update the name profile field with specified characteristics.

    Query Parameters:
    NameTypeRequiredDescription
    fieldsStringfalseFields to include in the returned entity
    Takes:
  • ProfileFieldName describing the profile field to be updated
    • Retrieves:
  • ProfileFieldName representing the updated profile field
    • Return Status:
    HTTP Status CodeDescription
    400 (Bad Request)An input field is malformed
    403 (Forbidden)You are not allowed to access the specified profile field or to make the requested change
    404 (Not Found)The specified profile field does not exist
    Since: 3.14