# org.passingreads.book.getRegistrationHints

> Published by [passingreads.org](https://lexicon.garden/identity/did:plc:oeipalbxet5jghoqe6b6ctu6)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:oeipalbxet5jghoqe6b6ctu6/org.passingreads.book.getRegistrationHints)
- [Documentation](https://lexicon.garden/lexicon/did:plc:oeipalbxet5jghoqe6b6ctu6/org.passingreads.book.getRegistrationHints/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:oeipalbxet5jghoqe6b6ctu6/org.passingreads.book.getRegistrationHints/examples)

## Definitions

### `org.passingreads.book.getRegistrationHints`

**Type**: `query`

Resolve the community's best guess at which publication an unregistered book is, from registration hints. Returns the publicationId suggested by the most hinters, ties broken by the earliest hint, so the registration flow can pre-fill and skip the search step.

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `bookId` | `string` | Yes | The book's ID (as defined on its QR Code). |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `publicationId` | `string` | No | The most-hinted Open Library Edition ID for this bookId (ties broken by the earliest hint). Absent when no one has hinted this book. |

## Raw Schema

```json
{
  "id": "org.passingreads.book.getRegistrationHints",
  "defs": {
    "main": {
      "type": "query",
      "output": {
        "schema": {
          "type": "object",
          "properties": {
            "publicationId": {
              "type": "string",
              "description": "The most-hinted Open Library Edition ID for this bookId (ties broken by the earliest hint). Absent when no one has hinted this book."
            }
          }
        },
        "encoding": "application/json"
      },
      "parameters": {
        "type": "params",
        "required": [
          "bookId"
        ],
        "properties": {
          "bookId": {
            "type": "string",
            "description": "The book's ID (as defined on its QR Code)."
          }
        }
      },
      "description": "Resolve the community's best guess at which publication an unregistered book is, from registration hints. Returns the publicationId suggested by the most hinters, ties broken by the earliest hint, so the registration flow can pre-fill and skip the search step."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```