# SeriesQuestionsChoicesApi

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

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**createSeriesQuestionChoice**](#createseriesquestionchoice) | **POST** /series/{seriesId}/questions/{questionId}/choices | Add a choice to a series question|
|[**deleteSeriesQuestionChoice**](#deleteseriesquestionchoice) | **DELETE** /series/{seriesId}/questions/{questionId}/choices/{choiceId} | Delete a series question choice|
|[**reorderSeriesQuestionChoices**](#reorderseriesquestionchoices) | **PUT** /series/{seriesId}/questions/{questionId}/choices/reorder | Reorder a series question\'s choices|
|[**updateSeriesQuestionChoice**](#updateseriesquestionchoice) | **PUT** /series/{seriesId}/questions/{questionId}/choices/{choiceId} | Update a series question choice|

# **createSeriesQuestionChoice**
> CreateSeriesQuestionChoice200Response createSeriesQuestionChoice(seriesQuestionChoiceCreateInputs)

Creates a new answer choice for a select/radio/checkbox question on a series, appending it to the end of the choice order unless a specific sortOrder is provided; requires update permission on events.

### Example

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

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

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

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

### Parameters

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


### Return type

**CreateSeriesQuestionChoice200Response**

### 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)

# **deleteSeriesQuestionChoice**
> CreateAccountInvitations200Response deleteSeriesQuestionChoice()

Permanently deletes an answer choice from a series question and re-sequences the sortOrder of the remaining choices; requires update permission on events.

### Example

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

const configuration = new Configuration();
const apiInstance = new SeriesQuestionsChoicesApi(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.deleteSeriesQuestionChoice(
    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

**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)

# **reorderSeriesQuestionChoices**
> ReorderSeriesQuestionChoices200Response reorderSeriesQuestionChoices(reorderBookingSpaceQuestionChoicesRequest)

Sets the display order of a series question\'s answer choices from a complete, ordered array of choice IDs; all existing choice IDs must be included or the request is rejected, and update permission on events is required.

### Example

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

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

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

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

### Parameters

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


### Return type

**ReorderSeriesQuestionChoices200Response**

### 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)

# **updateSeriesQuestionChoice**
> CreateSeriesQuestionChoice200Response updateSeriesQuestionChoice(seriesQuestionChoiceUpdateInputs)

Updates the properties (such as label or value) of an existing answer choice on a series question, identified by seriesId, questionId, and choiceId; requires update permission on events.

### Example

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

const configuration = new Configuration();
const apiInstance = new SeriesQuestionsChoicesApi(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)
let seriesQuestionChoiceUpdateInputs: SeriesQuestionChoiceUpdateInputs; //

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

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **seriesQuestionChoiceUpdateInputs** | **SeriesQuestionChoiceUpdateInputs**|  | |
| **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**: 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)