# Agent

Search API v0.6.7 · 2 operationer
Kilde: https://plasapi.com/da/search/v0.6.7/agent/

The people and organisations connected to works, such as authors, illustrators, translators, narrators and publishers. The vendor can fetch an agent by ID or search for agents by name, and see which works they are connected to and in which role.

## Get agents

`GET` `/agent` · `GetAgents`

### Eksempel på kald

**cURL**

```bash
curl -X GET "$PLAS_BASE_URL/agent?agent_ids=agent-4102&version=0.6.7" \
  -H 'Accept: application/json' \
  -H "Authorization: Bearer $PLAS_TOKEN"
```

**JavaScript**

```javascript
const response = await fetch(`${process.env.PLAS_BASE_URL}/agent?agent_ids=agent-4102&version=0.6.7`, {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": `Bearer ${process.env.PLAS_TOKEN}`,
  },
});
const data = await response.json();
```

**Python**

```python
import os
import requests

response = requests.get(
    f"{os.environ['PLAS_BASE_URL']}/agent",
    params={
        "agent_ids": "agent-4102",
        "version": "0.6.7",
    },
    headers={
        "Accept": "application/json",
        "Authorization": f"Bearer {os.environ['PLAS_TOKEN']}",
    },
)
data = response.json()
```

Værten og tokenet er miljøvariabler: `PLAS_BASE_URL` providerens adresse · `PLAS_TOKEN` et access token.

### Parametre

- `agent_ids` (i `query`, `array of string`, påkrævet) — A list of agent IDs, agent IDs should be url encoded and separated by a comma.

That means that, if you have e.g. three agent IDs "agent-123", "agent-456,abcd" and "789101112", they should be sent as: "agent_ids=agent-123,agent-456%2Cabcd,789101112".


Fælles for operationerne: `ui_language`, `version`. [Se den fælles kontrakt på versionssiden.](https://plasapi.com/da/search/v0.6.7/)

### Svar

#### `200` Success

`GetAgentsResponseBody`

Eksempel (Genereret ud fra skemaet):

```json
{
  "agents": {
    "agent-4102": {
      "description": "Norwegian novelist, awarded the Nobel Prize in Literature in 1928.",
      "fullName": "Sigrid Undset",
      "id": "agent-4102",
      "images": [
        {
          "height": 1200,
          "mime": "png",
          "url": "https://images.nordby.bibliotek.example/covers/310552.jpg",
          "width": 800,
          "type": "agent"
        }
      ],
      "active": {
        "type": "literal",
        "value": "1882-1949"
      },
      "birthDate": {
        "type": "literal",
        "value": "1920"
      },
      "deathDate": {
        "type": "literal",
        "value": "1920"
      },
      "externals": {
        "identifiers": [
          {
            "type": "norwegianAuthorityFile",
            "value": "4102"
          }
        ]
      },
      "givenName": "Kari",
      "surname": "Nordmann",
      "type": "person"
    }
  }
}
```

#### `400` The list of errors.

`Errors`

Fælles svar, defineret én gang for hele API’et. [Se den fælles kontrakt på versionssiden.](https://plasapi.com/da/search/v0.6.7/)

Eksempel (Genereret ud fra skemaet):

```json
{
  "errors": [
    {
      "code": 200103,
      "info": "200103: invalid/unsupported query parameter value"
    }
  ]
}
```

#### `401` Bearer token invalid, missing, or expired.

Intet indhold i svaret.

Fælles svar, defineret én gang for hele API’et. [Se den fælles kontrakt på versionssiden.](https://plasapi.com/da/search/v0.6.7/)

#### `404` Resource not found.

Intet indhold i svaret.

Fælles svar, defineret én gang for hele API’et. [Se den fælles kontrakt på versionssiden.](https://plasapi.com/da/search/v0.6.7/)

## Search Agents

`GET` `/agent/search` · `SearchAgents`

### Eksempel på kald

**cURL**

```bash
curl -X GET "$PLAS_BASE_URL/agent/search?version=0.6.7" \
  -H 'Accept: application/json' \
  -H "Authorization: Bearer $PLAS_TOKEN"
```

**JavaScript**

```javascript
const response = await fetch(`${process.env.PLAS_BASE_URL}/agent/search?version=0.6.7`, {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": `Bearer ${process.env.PLAS_TOKEN}`,
  },
});
const data = await response.json();
```

**Python**

```python
import os
import requests

response = requests.get(
    f"{os.environ['PLAS_BASE_URL']}/agent/search",
    params={
        "version": "0.6.7",
    },
    headers={
        "Accept": "application/json",
        "Authorization": f"Bearer {os.environ['PLAS_TOKEN']}",
    },
)
data = response.json()
```

Værten og tokenet er miljøvariabler: `PLAS_BASE_URL` providerens adresse · `PLAS_TOKEN` et access token.

### Parametre

- `query` (i `query`, `string`, valgfri) — Search agents.
- `page` (i `query`, `integer`, valgfri) — Page number (default 1).
- `size` (i `query`, `integer`, valgfri) — Page size (default 10).
- `types` (i `query`, `array of string`, valgfri) — List of agents types allowed in result.

Fælles for operationerne: `ui_language`, `version`. [Se den fælles kontrakt på versionssiden.](https://plasapi.com/da/search/v0.6.7/)

### Svar

#### `200` Success

`SearchAgentsResponseBody`

Eksempel (Genereret ud fra skemaet):

```json
{
  "results": [
    {
      "description": "Norwegian novelist, awarded the Nobel Prize in Literature in 1928.",
      "fullName": "Sigrid Undset",
      "id": "agent-4102",
      "images": [
        {
          "height": 1200,
          "mime": "png",
          "url": "https://images.nordby.bibliotek.example/covers/310552.jpg",
          "width": 800,
          "type": "agent"
        }
      ],
      "active": {
        "type": "literal",
        "value": "1882-1949"
      },
      "birthDate": {
        "type": "literal",
        "value": "1920"
      },
      "deathDate": {
        "type": "literal",
        "value": "1920"
      },
      "externals": {
        "identifiers": [
          {
            "type": "norwegianAuthorityFile",
            "value": "4102"
          }
        ]
      },
      "givenName": "Kari",
      "surname": "Nordmann",
      "type": "person"
    }
  ],
  "total": 12
}
```

#### `400` The list of errors.

`Errors`

Fælles svar, defineret én gang for hele API’et. [Se den fælles kontrakt på versionssiden.](https://plasapi.com/da/search/v0.6.7/)

Eksempel (Genereret ud fra skemaet):

```json
{
  "errors": [
    {
      "code": 200103,
      "info": "200103: invalid/unsupported query parameter value"
    }
  ]
}
```

#### `401` Bearer token invalid, missing, or expired.

Intet indhold i svaret.

Fælles svar, defineret én gang for hele API’et. [Se den fælles kontrakt på versionssiden.](https://plasapi.com/da/search/v0.6.7/)

#### `404` Resource not found.

Intet indhold i svaret.

Fælles svar, defineret én gang for hele API’et. [Se den fælles kontrakt på versionssiden.](https://plasapi.com/da/search/v0.6.7/)