# Speciality API

API for managing specialities

**Version:** 1.0.0

## Overview

### Base URLs

- **Production server**: `https://api.repzo.me/v1`

### API Categories

- **Speciality**: Speciality management operations

## Authentication

This API uses the following authentication methods:

- **ApiKeyAuth**

## Endpoints

### `/speciality`

#### GET /speciality

**Summary:** Get all specialities

**Description:** Retrieve a list of all specialities with optional filtering and pagination

**Tags:** Speciality

##### Parameters

| Name | Location | Type | Required | Description |
| ---- | -------- | ---- | -------- | ----------- |

| `page` | query | integer | No | Page number for pagination |

| `per_page` | query | integer | No | Number of items per page |

| `sort` | query | string | No | Sort field |

| `company_namespace` | query | array | No | Company namespace for filtering |

| `disabled` | query | boolean | No | Filter by disabled status |

| `_id` | query | array | No | Filter by ID |

##### Responses

**200** - Successful response

Content-Type: `application/json`

**400** - No description

**401** - No description

**403** - No description

**500** - No description

---

#### POST /speciality

**Summary:** Create a new speciality

**Description:** Create a new speciality entry

**Tags:** Speciality

##### Request Body

**Content Types:**

- `application/json`

##### Responses

**201** - Speciality created successfully

Content-Type: `application/json`

**400** - No description

**401** - No description

**403** - No description

**422** - No description

**500** - No description

---

### `/speciality/{id}`

#### GET /speciality/{id}

**Summary:** Get speciality by ID

**Description:** Retrieve a specific speciality by its ID

**Tags:** Speciality

##### Parameters

| Name | Location | Type | Required | Description |
| ---- | -------- | ---- | -------- | ----------- |

| `id` | path | string | Yes | Speciality ID |

##### Responses

**200** - Successful response

Content-Type: `application/json`

**400** - No description

**401** - No description

**403** - No description

**404** - No description

**500** - No description

---

#### PATCH /speciality/{id}

**Summary:** Update speciality

**Description:** Update an existing speciality

**Tags:** Speciality

##### Parameters

| Name | Location | Type | Required | Description |
| ---- | -------- | ---- | -------- | ----------- |

| `id` | path | string | Yes | Speciality ID |

##### Request Body

**Content Types:**

- `application/json`

##### Responses

**200** - Speciality updated successfully

Content-Type: `application/json`

**400** - No description

**401** - No description

**403** - No description

**404** - No description

**422** - No description

**500** - No description

---

#### DELETE /speciality/{id}

**Summary:** Delete speciality

**Description:** Delete a speciality by ID

**Tags:** Speciality

##### Parameters

| Name | Location | Type | Required | Description |
| ---- | -------- | ---- | -------- | ----------- |

| `id` | path | string | Yes | Speciality ID |

##### Responses

**200** - Speciality deleted successfully

Content-Type: `application/json`

**400** - No description

**401** - No description

**403** - No description

**404** - No description

**500** - No description

---

### `/speciality/remove`

#### POST /speciality/remove

**Summary:** Bulk delete specialities

**Description:** Delete multiple specialities by their IDs

**Tags:** Speciality

##### Request Body

**Content Types:**

- `application/json`

##### Responses

**200** - Specialities deleted successfully

Content-Type: `application/json`

**400** - No description

**401** - No description

**403** - No description

**500** - No description

---

## Data Models

### Speciality

| Property | Type | Required | Description |
| -------- | ---- | -------- | ----------- |

| `_id` | string | No | Unique identifier |

| `name` | string | Yes | Speciality name |

| `company_namespace` | array | No | Company namespace |

| `disabled` | boolean | No | Whether the speciality is disabled |

| `createdAt` | string | No | Creation timestamp |

| `modifiedAt` | string | No | Last modification timestamp |

| `SVClient` | integer | No | Client version |

| `__v` | integer | No | Document version |

### CreateSpecialityRequest

| Property | Type | Required | Description |
| -------- | ---- | -------- | ----------- |

| `name` | string | Yes | Speciality name |

| `company_namespace` | array | No | Company namespace |

| `disabled` | boolean | No | Whether the speciality is disabled |

### UpdateSpecialityRequest

| Property | Type | Required | Description |
| -------- | ---- | -------- | ----------- |

| `name` | string | No | Speciality name |

| `company_namespace` | array | No | Company namespace |

| `disabled` | boolean | No | Whether the speciality is disabled |

### PagingInfo

| Property | Type | Required | Description |
| -------- | ---- | -------- | ----------- |

| `total` | integer | No | Total number of items |

| `page` | integer | No | Current page number |

| `per_page` | integer | No | Items per page |

| `pages` | integer | No | Total number of pages |

## TypeScript Usage

See [speciality-examples.md](./speciality-examples.md) for detailed TypeScript usage examples.