# pub.chive.actor.autocompleteAffiliation

> Published by [chive.pub](https://lexicon.garden/identity/did:plc:7natp5xae72bddaqlkef2t4e)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:7natp5xae72bddaqlkef2t4e/pub.chive.actor.autocompleteAffiliation)
- [Documentation](https://lexicon.garden/lexicon/did:plc:7natp5xae72bddaqlkef2t4e/pub.chive.actor.autocompleteAffiliation/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:7natp5xae72bddaqlkef2t4e/pub.chive.actor.autocompleteAffiliation/examples)

## Definitions

### `pub.chive.actor.autocompleteAffiliation`

**Type**: `query`

Autocomplete institutional affiliations using the Research Organization Registry (ROR) API

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `limit` | `integer` | No | Maximum number of suggestions to return |
| `query` | `string` | Yes | Search query for institution name |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `suggestions` | `array` | Yes |  |

### `pub.chive.actor.autocompleteAffiliation#affiliationSuggestion`

**Type**: `object`

An affiliation suggestion from the ROR database

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `name` | `string` | Yes | Display name of the institution |
| `rorId` | `string` | Yes | ROR identifier URL (e.g., https://ror.org/02mhbdp94) |
| `types` | `array` | Yes | Organization types (e.g., Education, Nonprofit) |
| `acronym` | `string` | No | Institution acronym if available |
| `country` | `string` | Yes | Country where the institution is located |

## Raw Schema

```json
{
  "id": "pub.chive.actor.autocompleteAffiliation",
  "defs": {
    "main": {
      "type": "query",
      "errors": [],
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "suggestions"
          ],
          "properties": {
            "suggestions": {
              "type": "array",
              "items": {
                "ref": "#affiliationSuggestion",
                "type": "ref"
              }
            }
          }
        },
        "encoding": "application/json"
      },
      "parameters": {
        "type": "params",
        "required": [
          "query"
        ],
        "properties": {
          "limit": {
            "type": "integer",
            "default": 8,
            "maximum": 50,
            "minimum": 1,
            "description": "Maximum number of suggestions to return"
          },
          "query": {
            "type": "string",
            "minLength": 1,
            "description": "Search query for institution name"
          }
        }
      },
      "description": "Autocomplete institutional affiliations using the Research Organization Registry (ROR) API"
    },
    "affiliationSuggestion": {
      "type": "object",
      "required": [
        "rorId",
        "name",
        "country",
        "types"
      ],
      "properties": {
        "name": {
          "type": "string",
          "description": "Display name of the institution"
        },
        "rorId": {
          "type": "string",
          "description": "ROR identifier URL (e.g., https://ror.org/02mhbdp94)"
        },
        "types": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Organization types (e.g., Education, Nonprofit)"
        },
        "acronym": {
          "type": "string",
          "description": "Institution acronym if available"
        },
        "country": {
          "type": "string",
          "description": "Country where the institution is located"
        }
      },
      "description": "An affiliation suggestion from the ROR database"
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1,
  "revision": 1
}
```