Jump to

• Request
• Response

Get all properties for the specified user.

get

/social/api/v1/people/{peopleID}/properties

Request

Supported Media Types

• application/json

Path Parameters

• peopleID: integer(int64)
  The people ID. The object's unique identifier from a long integer representation.

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

V1 People Property List Information DTO.

Root Schema : XV1PeoplePropertyListInfo

Type: object

V1 People Property List Information DTO.

Show Source

• hasMore: boolean
  If true, there are more items to be returned.
• items: array items
  The properties being returned.
• nextURL: string(url)
  Next page URL for the list. Null if this is the last page.
• previousURL: string(url)
  Previous page URL for the list. Null if this is the first page.
• total: integer(int32)
  If specified, this is the total number of available items. Null if the total is unknown.

{
    "description":"V1 People Property List Information DTO.",
    "properties":{
        "items":{
            "description":"The properties being returned.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/XV1PeoplePropertyInfo"
            }
        },
        "hasMore":{
            "description":"If true, there are more items to be returned.",
            "type":"boolean"
        },
        "nextURL":{
            "description":"Next page URL for the list. Null if this is the last page.",
            "type":"string",
            "format":"url"
        },
        "previousURL":{
            "description":"Previous page URL for the list. Null if this is the first page.",
            "type":"string",
            "format":"url"
        },
        "total":{
            "description":"If specified, this is the total number of available items. Null if the total is unknown.",
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : items

Type: array

The properties being returned.

Show Source

• [0]: object XV1PeoplePropertyInfo
  V1 People Property Information DTO.

{
    "description":"The properties being returned.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/XV1PeoplePropertyInfo"
    }
}

Nested Schema : XV1PeoplePropertyInfo

Type: object

V1 People Property Information DTO.

Show Source

• name: string
  The property name.
• value: string(uuid)
  The property value.

{
    "description":"V1 People Property Information DTO.",
    "properties":{
        "name":{
            "description":"The property name.",
            "type":"string"
        },
        "value":{
            "description":"The property value.",
            "type":"string",
            "format":"uuid"
        }
    }
}