Skip to main content
Get Picture Folder Entity

Headers

Accept-Language
string

Convert string references and multi-language values into a specified language (iso2) code.

SO-Language
string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

SO-Culture
string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

SO-TimeZone
string

Specify the timezone code that you would like date/time responses converted to.

SO-AppToken
string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Path Parameters

id
integer<int32>
required

The id of the PictureFolderEntity to return.

Query Parameters

$select
string

Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category" Default = show all fields.

Response

PictureFolderEntity found.

Picture/mailing folder (s_picture_folder) PictureFolderEntity entity with API _Links added.

SPictureFolderId
integer<int32>

Primary key

Name
string

Name of folder

ParentId
integer<int32>

The parent id for this folder. -1 for root folders

Description
string

A description of the folder

FolderType
integer<int32>

Indicates which type of folder this is

Children
object[]

Sub-folders, if any.

Registered
string<date-time>

Registered when in UTC.

RegisteredAssociateId
integer<int32>

Registered by whom

Updated
string<date-time>

Last updated when in UTC.

UpdatedAssociateId
integer<int32>

Last updated by whom

TableRight
object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

FieldProperties
object

Field property dictionary mapping field names to field access rights.