# xyz.opnshelf.rating

> Published by [opnshelf.xyz](https://lexicon.garden/identity/did:plc:jkf4momksftvstbyqnb5sxik)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:jkf4momksftvstbyqnb5sxik/xyz.opnshelf.rating)
- [Documentation](https://lexicon.garden/lexicon/did:plc:jkf4momksftvstbyqnb5sxik/xyz.opnshelf.rating/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:jkf4momksftvstbyqnb5sxik/xyz.opnshelf.rating/examples)

## Definitions

### `xyz.opnshelf.rating`

**Type**: `record`

A user's numeric rating for a media item (one per user per media item)

**Key**: `tid`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `rating` | `integer` | Yes | Rating from 1 to 10 (maps to 0.5-5.0 stars) |
| `mediaId` | `string` | Yes | TMDB movie ID or show ID |
| `createdAt` | `string` (datetime) | Yes | Record creation timestamp |
| `mediaType` | `string` | Yes | Media type |
| `seasonNumber` | `integer` | No | Season number for season/episode items |
| `episodeNumber` | `integer` | No | Episode number for episode items |

## Raw Schema

```json
{
  "id": "xyz.opnshelf.rating",
  "defs": {
    "main": {
      "key": "tid",
      "type": "record",
      "record": {
        "type": "object",
        "required": [
          "mediaType",
          "mediaId",
          "rating",
          "createdAt"
        ],
        "properties": {
          "rating": {
            "type": "integer",
            "maximum": 10,
            "minimum": 1,
            "description": "Rating from 1 to 10 (maps to 0.5-5.0 stars)"
          },
          "mediaId": {
            "type": "string",
            "description": "TMDB movie ID or show ID"
          },
          "createdAt": {
            "type": "string",
            "format": "datetime",
            "description": "Record creation timestamp"
          },
          "mediaType": {
            "enum": [
              "movie",
              "show",
              "season",
              "episode"
            ],
            "type": "string",
            "description": "Media type"
          },
          "seasonNumber": {
            "type": "integer",
            "description": "Season number for season/episode items"
          },
          "episodeNumber": {
            "type": "integer",
            "description": "Episode number for episode items"
          }
        }
      },
      "description": "A user's numeric rating for a media item (one per user per media item)"
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```