# SeriesQuestionsApi

All URIs are relative to *https://admin-api.connected.dev*

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**createSeriesQuestion**](#createseriesquestion) | **POST** /series/{seriesId}/questions | Create a registration question for a series|
|[**deleteSeriesQuestion**](#deleteseriesquestion) | **DELETE** /series/{seriesId}/questions/{questionId} | Delete a series registration question|
|[**getSeriesQuestion**](#getseriesquestion) | **GET** /series/{seriesId}/questions/{questionId} | Get a series registration question|
|[**getSeriesQuestionChoice**](#getseriesquestionchoice) | **GET** /series/{seriesId}/questions/{questionId}/choices/{choiceId} | Get a series question choice|
|[**getSeriesQuestionChoices**](#getseriesquestionchoices) | **GET** /series/{seriesId}/questions/{questionId}/choices | List a series question\'s choices|
|[**getSeriesQuestions**](#getseriesquestions) | **GET** /series/{seriesId}/questions | List a series\' registration questions|
|[**updateSeriesQuestion**](#updateseriesquestion) | **PUT** /series/{seriesId}/questions/{questionId} | Update a series registration question|

# **createSeriesQuestion**
> CreateSeriesQuestion200Response createSeriesQuestion(seriesQuestionCreateInputs)

Creates a new registration question on the series, optionally with an initial list of answer choices, inserting it at the given sortOrder or appending it to the end; requires update permission on events.

### Example

```typescript
import {
    SeriesQuestionsApi,
    Configuration,
    SeriesQuestionCreateInputs
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new SeriesQuestionsApi(configuration);

let seriesId: string; //The series identifier (default to undefined)
let seriesQuestionCreateInputs: SeriesQuestionCreateInputs; //

const { status, data } = await apiInstance.createSeriesQuestion(
    seriesId,
    seriesQuestionCreateInputs
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **seriesQuestionCreateInputs** | **SeriesQuestionCreateInputs**|  | |
| **seriesId** | [**string**] | The series identifier | defaults to undefined|


### Return type

**CreateSeriesQuestion200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **deleteSeriesQuestion**
> CreateAccountInvitations200Response deleteSeriesQuestion()

Permanently deletes a registration question from a series and re-sequences the sortOrder of the remaining questions; requires update permission on events.

### Example

```typescript
import {
    SeriesQuestionsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new SeriesQuestionsApi(configuration);

let seriesId: string; //The series identifier (default to undefined)
let questionId: string; //The question identifier (default to undefined)

const { status, data } = await apiInstance.deleteSeriesQuestion(
    seriesId,
    questionId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **seriesId** | [**string**] | The series identifier | defaults to undefined|
| **questionId** | [**string**] | The question identifier | defaults to undefined|


### Return type

**CreateAccountInvitations200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getSeriesQuestion**
> CreateSeriesQuestion200Response getSeriesQuestion()

Returns a single registration question configured for the given series, identified by its question ID, requires the \"read\" permission on the events module.

### Example

```typescript
import {
    SeriesQuestionsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new SeriesQuestionsApi(configuration);

let seriesId: string; //The series identifier (default to undefined)
let questionId: string; //The question identifier (default to undefined)

const { status, data } = await apiInstance.getSeriesQuestion(
    seriesId,
    questionId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **seriesId** | [**string**] | The series identifier | defaults to undefined|
| **questionId** | [**string**] | The question identifier | defaults to undefined|


### Return type

**CreateSeriesQuestion200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getSeriesQuestionChoice**
> CreateSeriesQuestionChoice200Response getSeriesQuestionChoice()

Returns a single answer choice for a series registration question, identified by its choice ID, requires the \"read\" permission on the events module.

### Example

```typescript
import {
    SeriesQuestionsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new SeriesQuestionsApi(configuration);

let seriesId: string; //The series identifier (default to undefined)
let questionId: string; //The question identifier (default to undefined)
let choiceId: string; //The choice identifier (default to undefined)

const { status, data } = await apiInstance.getSeriesQuestionChoice(
    seriesId,
    questionId,
    choiceId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **seriesId** | [**string**] | The series identifier | defaults to undefined|
| **questionId** | [**string**] | The question identifier | defaults to undefined|
| **choiceId** | [**string**] | The choice identifier | defaults to undefined|


### Return type

**CreateSeriesQuestionChoice200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getSeriesQuestionChoices**
> GetSeriesQuestionChoices200Response getSeriesQuestionChoices()

Returns a paginated list of answer choices belonging to a series registration question, supporting search and ordering, requires the \"read\" permission on the events module.

### Example

```typescript
import {
    SeriesQuestionsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new SeriesQuestionsApi(configuration);

let seriesId: string; //The series identifier (default to undefined)
let questionId: string; //The question identifier (default to undefined)
let page: number; //Page number (optional) (default to 1)
let pageSize: number; //Number of items per page (optional) (default to 25)
let orderBy: string; //Field to order by (optional) (default to undefined)
let search: string; //Search query (optional) (default to undefined)

const { status, data } = await apiInstance.getSeriesQuestionChoices(
    seriesId,
    questionId,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **seriesId** | [**string**] | The series identifier | defaults to undefined|
| **questionId** | [**string**] | The question identifier | defaults to undefined|
| **page** | [**number**] | Page number | (optional) defaults to 1|
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
| **search** | [**string**] | Search query | (optional) defaults to undefined|


### Return type

**GetSeriesQuestionChoices200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getSeriesQuestions**
> GetSeriesQuestions200Response getSeriesQuestions()

Returns a paginated list of registration questions configured for the given series, supporting search and ordering, requires the \"read\" permission on the events module.

### Example

```typescript
import {
    SeriesQuestionsApi,
    Configuration
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new SeriesQuestionsApi(configuration);

let seriesId: string; //The series identifier (default to undefined)
let page: number; //Page number (optional) (default to 1)
let pageSize: number; //Number of items per page (optional) (default to 25)
let orderBy: string; //Field to order by (optional) (default to undefined)
let search: string; //Search query (optional) (default to undefined)

const { status, data } = await apiInstance.getSeriesQuestions(
    seriesId,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **seriesId** | [**string**] | The series identifier | defaults to undefined|
| **page** | [**number**] | Page number | (optional) defaults to 1|
| **pageSize** | [**number**] | Number of items per page | (optional) defaults to 25|
| **orderBy** | [**string**] | Field to order by | (optional) defaults to undefined|
| **search** | [**string**] | Search query | (optional) defaults to undefined|


### Return type

**GetSeriesQuestions200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **updateSeriesQuestion**
> CreateSeriesQuestion200Response updateSeriesQuestion(seriesQuestionUpdateInputs)

Updates the properties of a registration question on a series, such as its label, type, or required flag, and re-sequences sortOrder among sibling questions if a new sortOrder is supplied; requires update permission on events.

### Example

```typescript
import {
    SeriesQuestionsApi,
    Configuration,
    SeriesQuestionUpdateInputs
} from '@connectedxm/admin-sdk';

const configuration = new Configuration();
const apiInstance = new SeriesQuestionsApi(configuration);

let seriesId: string; //The series identifier (default to undefined)
let questionId: string; //The question identifier (default to undefined)
let seriesQuestionUpdateInputs: SeriesQuestionUpdateInputs; //

const { status, data } = await apiInstance.updateSeriesQuestion(
    seriesId,
    questionId,
    seriesQuestionUpdateInputs
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **seriesQuestionUpdateInputs** | **SeriesQuestionUpdateInputs**|  | |
| **seriesId** | [**string**] | The series identifier | defaults to undefined|
| **questionId** | [**string**] | The question identifier | defaults to undefined|


### Return type

**CreateSeriesQuestion200Response**

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth), [OrganizationId](../README.md#OrganizationId)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)