getUsersByUseridSuggestions
Gets items based on a query.
Requires authentication as user
getUsersByUseridSuggestions
Request
get /Users/{UserId}/Suggestions
Parameters
Name | In | Type | Default | Notes |
---|---|---|---|---|
*UserId | path | |||
Fields | query | Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimeted. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls |
||
EnableImages | query | Optional, include image information in output |
||
ImageTypeLimit | query | Optional, the max number of images to return, per image type |
||
EnableImageTypes | query | Optional. The image types to include in the output. |
||
EnableUserData | query | Optional, include user data |
Responses
Status Code | Type | Description | Samples |
---|---|---|---|
200 | QueryResult_BaseItemDto | Operation successful. Returning a QueryResult
|
|
400 | Bad Request. Server cannot process request. |
||
401 | Unauthorized. Client needs to authenticate. |
||
403 | Forbidden. No permission for the reqested operation. |
||
404 | Resource not found or unavailable. |
||
500 | Server error. |
Definitions
QueryResult_BaseItemDto
Name | Type | Notes |
---|---|---|
Items | BaseItemDto[] | |
TotalRecordCount | integer (int32) |
BaseItemDto
see also MediaBrowser.Model.Dto.BaseItemDto
Name | Type | Notes |
---|---|---|
Name | string | The name. |
OriginalTitle | string | |
ServerId | string | The server identifier. |
Id | string | The id. |
Guid | string | |
Etag | string | The etag. |
Prefix | string | The Prefix. |
PlaylistItemId | string | The playlist item identifier. |
DateCreated | string (date-time) | The date created. |
ExtraType | string | |
SortIndexNumber | integer (int32) | |
SortParentIndexNumber | integer (int32) | |
CanDelete | boolean | |
CanDownload | boolean | |
CanEditItems | boolean | |
SupportsResume | boolean | |
PresentationUniqueKey | string | |
PreferredMetadataLanguage | string | |
PreferredMetadataCountryCode | string | |
SupportsSync | boolean | A value indicating whether [supports synchronize]. |
SyncStatus | SyncJobItemStatus | |
CanManageAccess | boolean | |
CanLeaveContent | boolean | |
CanMakePublic | boolean | |
Container | string | |
SortName | string | The name of the sort. |
ForcedSortName | string | |
Video3DFormat | Video3DFormat | |
PremiereDate | string (date-time) | The premiere date. |
ExternalUrls | ExternalUrl[] | The external urls. |
MediaSources | MediaSourceInfo[] | The media versions. |
CriticRating | number (float) | The critic rating. |
GameSystemId | integer (int64) | |
AsSeries | boolean | |
GameSystem | string | The game system. |
ProductionLocations | array | |
Path | string | The path. |
OfficialRating | string | The official rating. |
CustomRating | string | The custom rating. |
ChannelId | string | The channel identifier. |
ChannelName | string | |
Overview | string | The overview. |
Taglines | array | The taglines. |
Genres | array | The genres. |
CommunityRating | number (float) | The community rating. |
RunTimeTicks | integer (int64) | The run time ticks. |
Size | integer (int64) | |
FileName | string | |
Bitrate | integer (int32) | |
ProductionYear | integer (int32) | The production year. |
Number | string | The number. |
ChannelNumber | string | |
IndexNumber | integer (int32) | The index number. |
IndexNumberEnd | integer (int32) | The index number end. |
ParentIndexNumber | integer (int32) | The parent index number. |
RemoteTrailers | MediaUrl[] | The trailer urls. |
ProviderIds | ProviderIdDictionary | |
IsFolder | boolean | A value indicating whether this instance is folder. |
ParentId | string | The parent id. |
Type | string | The type. |
People | BaseItemPerson[] | The people. |
Studios | NameLongIdPair[] | The studios. |
GenreItems | NameLongIdPair[] | |
TagItems | NameLongIdPair[] | |
ParentLogoItemId | string | If the item does not have a logo, this will hold the Id of the Parent that has one. |
ParentBackdropItemId | string | If the item does not have any backdrops, this will hold the Id of the Parent that has one. |
ParentBackdropImageTags | array | The parent backdrop image tags. |
LocalTrailerCount | integer (int32) | The local trailer count. |
UserData | UserItemDataDto[] | Class UserItemDataDto |
RecursiveItemCount | integer (int32) | The recursive item count. |
ChildCount | integer (int32) | The child count. |
SeriesName | string | The name of the series. |
SeriesId | string | The series id. |
SeasonId | string | The season identifier. |
SpecialFeatureCount | integer (int32) | The special feature count. |
DisplayPreferencesId | string | The display preferences id. |
Status | string | The status. |
AirDays | DayOfWeek[] | The air days. |
Tags | array | The tags. |
PrimaryImageAspectRatio | number (double) | The primary image aspect ratio, after image enhancements. |
Artists | array | The artists. |
ArtistItems | NameIdPair[] | The artist items. |
Composers | NameIdPair[] | |
Album | string | The album. |
CollectionType | string | The type of the collection. |
DisplayOrder | string | The display order. |
AlbumId | string | The album id. |
AlbumPrimaryImageTag | string | The album image tag. |
SeriesPrimaryImageTag | string | The series primary image tag. |
AlbumArtist | string | The album artist. |
AlbumArtists | NameIdPair[] | The album artists. |
SeasonName | string | The name of the season. |
MediaStreams | MediaStream[] | The media streams. |
PartCount | integer (int32) | The part count. |
ImageTags | object | The image tags. |
BackdropImageTags | array | The backdrop image tags. |
ParentLogoImageTag | string | The parent logo image tag. |
SeriesStudio | string | The series studio. |
PrimaryImageItemId | string | |
PrimaryImageTag | string | |
ParentThumbItemId | string | The parent thumb item id. |
ParentThumbImageTag | string | The parent thumb image tag. |
Chapters | ChapterInfo[] | The chapters. |
LocationType | LocationType | Enum LocationType |
MediaType | string | The type of the media. |
EndDate | string (date-time) | The end date. |
LockedFields | MetadataFields[] | The locked fields. |
LockData | boolean | A value indicating whether [enable internet providers]. |
Width | integer (int32) | |
Height | integer (int32) | |
CameraMake | string | |
CameraModel | string | |
Software | string | |
ExposureTime | number (double) | |
FocalLength | number (double) | |
ImageOrientation | ImageOrientation | |
Aperture | number (double) | |
ShutterSpeed | number (double) | |
Latitude | number (double) | |
Longitude | number (double) | |
Altitude | number (double) | |
IsoSpeedRating | integer (int32) | |
SeriesTimerId | string | The series timer identifier. |
ChannelPrimaryImageTag | string | The channel primary image tag. |
StartDate | string (date-time) | The start date of the recording, in UTC. |
CompletionPercentage | number (double) | The completion percentage. |
IsRepeat | boolean | A value indicating whether this instance is repeat. |
IsNew | boolean | |
EpisodeTitle | string | The episode title. |
IsMovie | boolean | A value indicating whether this instance is movie. |
IsSports | boolean | A value indicating whether this instance is sports. |
IsSeries | boolean | A value indicating whether this instance is series. |
IsLive | boolean | A value indicating whether this instance is live. |
IsNews | boolean | A value indicating whether this instance is news. |
IsKids | boolean | A value indicating whether this instance is kids. |
IsPremiere | boolean | A value indicating whether this instance is premiere. |
TimerType | TimerType | |
Disabled | boolean | |
ManagementId | string | |
TimerId | string | The timer identifier. |
CurrentProgram | ||
MovieCount | integer (int32) | |
SeriesCount | integer (int32) | |
AlbumCount | integer (int32) | |
SongCount | integer (int32) | |
MusicVideoCount | integer (int32) | |
Subviews | array | |
ListingsProviderId | string | |
ListingsChannelId | string | |
ListingsPath | string | |
ListingsId | string | |
ListingsChannelName | string | |
ListingsChannelNumber | string | |
AffiliateCallSign | string |
SyncJobItemStatus
Enum Values
- Queued
- Converting
- ReadyToTransfer
- Transferring
- Synced
- Failed
Video3DFormat
Enum Values
- HalfSideBySide
- FullSideBySide
- FullTopAndBottom
- HalfTopAndBottom
- MVC
ExternalUrl
Name | Type | Notes |
---|---|---|
Name | string | The name. |
Url | string | The type of the item. |
MediaSourceInfo
Name | Type | Notes |
---|---|---|
Protocol | MediaProtocol | |
Id | string | |
Path | string | |
EncoderPath | string | |
EncoderProtocol | MediaProtocol | |
Type | MediaSourceType | |
ProbePath | string | |
ProbeProtocol | MediaProtocol | |
Container | string | |
Size | integer (int64) | |
Name | string | |
SortName | string | |
IsRemote | boolean | Differentiate internet url vs local network |
HasMixedProtocols | boolean | |
RunTimeTicks | integer (int64) | |
ContainerStartTimeTicks | integer (int64) | |
SupportsTranscoding | boolean | |
TrancodeLiveStartIndex | integer (int32) | |
WallClockStart | string (date-time) | |
SupportsDirectStream | boolean | |
SupportsDirectPlay | boolean | |
IsInfiniteStream | boolean | |
RequiresOpening | boolean | |
OpenToken | string | |
RequiresClosing | boolean | |
LiveStreamId | string | |
BufferMs | integer (int32) | |
RequiresLooping | boolean | |
SupportsProbing | boolean | |
Video3DFormat | Video3DFormat | |
MediaStreams | MediaStream[] | |
Formats | array | |
Bitrate | integer (int32) | |
Timestamp | TransportStreamTimestamp | |
RequiredHttpHeaders | object | |
DirectStreamUrl | string | |
AddApiKeyToDirectStreamUrl | boolean | |
TranscodingUrl | string | |
TranscodingSubProtocol | string | |
TranscodingContainer | string | |
AnalyzeDurationMs | integer (int32) | |
ReadAtNativeFramerate | boolean | |
DefaultAudioStreamIndex | integer (int32) | |
DefaultSubtitleStreamIndex | integer (int32) | |
ItemId | string | Used only by our Windows app. Not used by Emby Server. The id of the item that this mediasource belongs to, if there is one Also used by Emby for Kodi |
ServerId | string | Used only by our Windows app. Not used by Emby Server. |
MediaProtocol
Enum Values
- File
- Http
- Rtmp
- Rtsp
- Udp
- Rtp
- Ftp
- Mms
MediaSourceType
Enum Values
- Default
- Grouping
- Placeholder
MediaStream
Name | Type | Notes |
---|---|---|
Codec | string | The codec. Probe Field: |
CodecTag | string | The codec tag. Probe Field: |
Language | string | The language. Probe Field: |
ColorTransfer | string | The color transfer characteristics. Probe Field: |
ColorPrimaries | string | The chromaticity coordinates of the source primaries. Probe Field: |
ColorSpace | string | The YUV colorspace type. Probe Field: |
Comment | string | The comment. Probe Field: |
StreamStartTimeTicks | integer (int64) | The start time of the stream. Probe Field: |
TimeBase | string | The time-base. Probe Field: |
Title | string | The title. Probe Field: |
Extradata | string | The extradata. Probe Field: Currently, this value is only parsed for subtitle streams with codec |
VideoRange | string | |
DisplayTitle | string | The display title. Custom property set by the application. |
DisplayLanguage | string | The display language. Custom property set by the application. |
NalLengthSize | string | The nal length size. Probe Field: |
IsInterlaced | boolean | A value indicating whether this instance is interlaced. Probe Field: |
IsAVC | boolean | |
ChannelLayout | string | The channel layout. Probe Field: |
BitRate | integer (int32) | The bit rate. Probe Field: THIS VALUE IS PROCESSED BY CUSTOM LOGIC AND DOES NOT NECESSARILY MATCH FFPROBE RESULTS! |
BitDepth | integer (int32) | The bit depth. Probe Field: |
RefFrames | integer (int32) | The reference frames. Probe Field: |
Rotation | integer (int32) | |
Channels | integer (int32) | The audio channel count. Probe Field: |
SampleRate | integer (int32) | The sample rate. Probe Field: |
IsDefault | boolean | A value indicating whether this instance is default. Probe Field: |
IsForced | boolean | A value indicating whether this instance is forced. Probe Field: |
IsHearingImpaired | boolean | |
Height | integer (int32) | The height. Probe Field: |
Width | integer (int32) | The width. Probe Field: |
AverageFrameRate | number (float) | The average frame rate.. Probe Field: |
RealFrameRate | number (float) | The real frame rate.. Probe Field: |
Profile | string | The profile. Probe Field: |
Type | MediaStreamType | Enum MediaStreamType |
AspectRatio | string | The aspect ratio. Probe Field: |
Index | integer (int32) | The index of the stream inside its container. Probe Field: |
IsExternal | boolean | A value indicating whether this instance is external. Custom property set by the application. |
DeliveryMethod | SubtitleDeliveryMethod | |
DeliveryUrl | string | The delivery URL. Custom property set by the application. |
IsExternalUrl | boolean | A value indicating whether this instance is external URL. Custom property set by the application. |
IsTextSubtitleStream | boolean | |
SupportsExternalStream | boolean | A value indicating whether [supports external stream]. |
Path | string | The filename. |
Protocol | MediaProtocol | |
PixelFormat | string | The pixel format. Probe Field: |
Level | number (double) | The codec level. Probe Field: |
IsAnamorphic | boolean | A value indicating whether this instance is anamorphic. |
ExtendedVideoType | ExtendedVideoTypes | |
ExtendedVideoSubType | ExtendedVideoSubTypes | |
ExtendedVideoSubTypeDescription | string | The extended video sub-type description. |
ItemId | string | Used only by our Windows app. Not used by Emby Server. |
ServerId | string | Used only by our Windows app. Not used by Emby Server. |
AttachmentSize | integer (int32) | The size of the attachment. |
MimeType | string | The type of the MIME. |
SubtitleLocationType | SubtitleLocationType |
MediaStreamType
Enum Values
- Unknown
- Audio
- Video
- Subtitle
- EmbeddedImage
- Attachment
- Data
SubtitleDeliveryMethod
Enum Values
- Encode
- Embed
- External
- Hls
- VideoSideData
ExtendedVideoTypes
Enum Values
- None
- Hdr10
- Hdr10Plus
- HyperLogGamma
- DolbyVision
ExtendedVideoSubTypes
Enum Values
- None
- Hdr10
- HyperLogGamma
- Hdr10Plus0
- DoviProfile02
- DoviProfile10
- DoviProfile22
- DoviProfile30
- DoviProfile42
- DoviProfile50
- DoviProfile61
- DoviProfile76
- DoviProfile81
- DoviProfile82
- DoviProfile83
- DoviProfile84
- DoviProfile85
- DoviProfile92
SubtitleLocationType
Enum Values
- InternalStream
- VideoSideData
TransportStreamTimestamp
Enum Values
- None
- Zero
- Valid
MediaUrl
see also MediaBrowser.Model.Entities.MediaUrl
Name | Type | Notes |
---|---|---|
Url | string | |
Name | string |
ProviderIdDictionary
BaseItemPerson
Name | Type | Notes |
---|---|---|
Name | string | The name. |
Id | string | The identifier. |
Role | string | The role. |
Type | PersonType | |
PrimaryImageTag | string | The primary image tag. |
PersonType
Enum Values
- Actor
- Director
- Writer
- Producer
- GuestStar
- Composer
- Conductor
- Lyricist
NameLongIdPair
Name | Type | Notes |
---|---|---|
Name | string | The name. |
Id | integer (int64) | The identifier. |
UserItemDataDto
Name | Type | Notes |
---|---|---|
Rating | number (double) | The rating. |
PlayedPercentage | number (double) | The played percentage. |
UnplayedItemCount | integer (int32) | The unplayed item count. |
PlaybackPositionTicks | integer (int64) | The playback position ticks. |
PlayCount | integer (int32) | The play count. |
IsFavorite | boolean | A value indicating whether this instance is favorite. |
LastPlayedDate | string (date-time) | The last played date. |
Played | boolean | A value indicating whether this |
Key | string | The key. |
ItemId | string | The item identifier. |
ServerId | string | Used only by our Windows app. Not used by Emby Server. |
DayOfWeek
NameIdPair
see also MediaBrowser.Model.Dto.NameIdPair
Name | Type | Notes |
---|---|---|
Name | string | The name. |
Id | string | The identifier. |
ChapterInfo
Name | Type | Notes |
---|---|---|
StartPositionTicks | integer (int64) | The start position ticks. |
Name | string | The name. |
ImageTag | string | |
MarkerType | MarkerType | |
ChapterIndex | integer (int32) |
MarkerType
Enum Values
- Chapter
- IntroStart
- IntroEnd
- CreditsStart
LocationType
Enum Values
- FileSystem
- Virtual
MetadataFields
ImageOrientation
Enum Values
- TopLeft
- TopRight
- BottomRight
- BottomLeft
- LeftTop
- RightTop
- RightBottom
- LeftBottom
TimerType
see also MediaBrowser.Model.LiveTv.TimerType
Enum Values
- Program
- DateTime
- Keyword