search_item

The search_item function is used to find an item with a certain ID.

Copied!
svc=core/search_item&params={"id":<long>,
			     "flags":<long>}

Parameters

NameDescription

id

Item ID.

flags

Flags with properties for the returned result. The value of this parameter depends on the item type. The data formats of all item types and their flags are described in the format section. 

Returned result

Copied!
{
	"item":{	/* found item */
		...	
	},
	"flags":<uint>	/* applied flags with properties */
}

The format of the item parameter depends on the item type. All formats are described in the format section.

Possible error codes:

CodeDescription
7

One of the following:

  • failed to get the current user;
  • failed to find the item with the certain ID;
  • the item is not active. 
6No session.
Download PDF file
Download Word document

See also