Jump to

• Request
• Response

Update a Preference

put

/api/AAA/Preferences/{id}

Updates the properties of the preference that matches the specified ID.

Request

Path Parameters

• id(required): integer(int32)
  The preference ID.

  Example:

  1

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Details of the preference to create or update.

Show Source

• PackageName: string
  The package name.

  Example: event
• PreferenceDescription: string
  The description of the preference.

  Example: Default event list display (default 'Default')
• PreferenceName: string
  The preference name.
  To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.

  Example: DefaultDisplayID
• RenderTypeID: integer
  The render type ID.

  Example: 20004

{
    "properties":{
        "PackageName":{
            "description":"The package name.",
            "type":"string",
            "example":"event"
        },
        "PreferenceName":{
            "description":"The preference name.\n<br>To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, <b>1234</b>, <b>+1234</b>, and <b>-1234</b> are not valid, but <b>US1234</b>, <b>US+1234</b> and <b>US_1234</b> are.",
            "type":"string",
            "example":"DefaultDisplayID"
        },
        "PreferenceDescription":{
            "description":"The description of the preference.",
            "type":"string",
            "example":"Default event list display (default 'Default')"
        },
        "RenderTypeID":{
            "description":"The render type ID.",
            "type":"integer",
            "example":"20004"
        }
    },
    "type":"object",
    "description":"Details of the preference to create or update."
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulUpdateOperation
  The response body for a successful update operation.
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulUpdateOperation"
        },
        {
            "type":"object",
            "properties":{
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                },
                "data":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/AAAPreferenceRead"
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulUpdateOperation

Type: object

The response body for a successful update operation.

Show Source

• message: string
  The response message.

  Example: Updated record
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "description":"The response body for a successful update operation.",
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Updated record"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data
• total: integer
  The total number of results regardless of paging.

  Example: 1

{
    "type":"object",
    "properties":{
        "total":{
            "description":"The total number of results regardless of paging.",
            "type":"integer",
            "example":"1"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AAAPreferenceRead"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object AAAPreferenceRead
  Preference details.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/AAAPreferenceRead"
    }
}

Nested Schema : AAAPreferenceRead

Type: object

Preference details.

Show Source

• PackageName: string
  The package name.

  Example: event
• PreferenceDescription: string
  The description of the preference.

  Example: Default event list display (default 'Default')
• PreferenceID: integer
  The preference ID.

  Example: 3
• PreferenceName: string
  The preference name.

  Example: DefaultDisplayID
• RenderType: string
  The render type.

  Example: { "id":"1", "name":"String" }
• RenderTypeID: integer
  The render type ID.

  Example: 20004

{
    "properties":{
        "PreferenceID":{
            "description":"The preference ID.",
            "type":"integer",
            "example":"3"
        },
        "PackageName":{
            "description":"The package name.",
            "type":"string",
            "example":"event"
        },
        "PreferenceName":{
            "description":"The preference name.",
            "type":"string",
            "example":"DefaultDisplayID"
        },
        "PreferenceDescription":{
            "description":"The description of the preference.",
            "type":"string",
            "example":"Default event list display (default 'Default')"
        },
        "RenderType":{
            "description":"The render type.",
            "type":"string",
            "example":{
                "id":"1",
                "name":"String"
            }
        },
        "RenderTypeID":{
            "description":"The render type ID.",
            "type":"integer",
            "example":"20004"
        }
    },
    "type":"object",
    "description":"Preference details."
}

Default Response

Failed operation

Body ()

Root Schema : schema

Type: object

Show Source

• errors: array errors
  The list of errors reported. Validation errors will be keyed by record field.
• message: string
  The response message.

  Example: Exception thrown
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: false

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "description":"An error.",
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

• Array of: object items
  An error.

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "description":"An error.",
        "type":"object"
    }
}

Nested Schema : items

Type: object

An error.

Back to Top