# SurveysSubmissionsApi

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

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**deleteSurveySubmission**](#deletesurveysubmission) | **DELETE** /surveys/{surveyId}/submissions/{submissionId} | Delete a survey submission|
|[**getSurveySubmission**](#getsurveysubmission) | **GET** /surveys/{surveyId}/submissions/{submissionId} | Get a survey submission|
|[**getSurveySubmissionQuestionSections**](#getsurveysubmissionquestionsections) | **GET** /surveys/{surveyId}/submissions/{submissionId}/sections | List a submission\'s sections, questions, and choices|
|[**getSurveySubmissionResponseChanges**](#getsurveysubmissionresponsechanges) | **GET** /surveys/{surveyId}/submissions/{submissionId}/responses/{questionId}/changes | List the edit history of a submission response|
|[**getSurveySubmissions**](#getsurveysubmissions) | **GET** /surveys/{surveyId}/submissions | List a survey\'s submissions|
|[**updateSurveySubmission**](#updatesurveysubmission) | **PUT** /surveys/{surveyId}/submissions/{submissionId} | Update a survey submission|
|[**updateSurveySubmissionResponses**](#updatesurveysubmissionresponses) | **PUT** /surveys/{surveyId}/submissions/{submissionId}/responses | Replace a submission\'s question responses|

# **deleteSurveySubmission**
> CreateAccountInvitations200Response deleteSurveySubmission()

Permanently deletes a respondent\'s submission (and its answers) for a survey; requires the delete surveys permission.

### Example

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

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

let surveyId: string; //The survey identifier (default to undefined)
let submissionId: string; //The submission identifier (default to undefined)

const { status, data } = await apiInstance.deleteSurveySubmission(
    surveyId,
    submissionId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **surveyId** | [**string**] | The survey identifier | defaults to undefined|
| **submissionId** | [**string**] | The submission 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)

# **getSurveySubmission**
> GetSurveySubmission200Response getSurveySubmission()

Retrieves a single survey submission by ID for the given survey, including its responses, requiring read permission on surveys.

### Example

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

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

let surveyId: string; //The survey identifier (default to undefined)
let submissionId: string; //The submission identifier (default to undefined)

const { status, data } = await apiInstance.getSurveySubmission(
    surveyId,
    submissionId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **surveyId** | [**string**] | The survey identifier | defaults to undefined|
| **submissionId** | [**string**] | The submission identifier | defaults to undefined|


### Return type

**GetSurveySubmission200Response**

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

# **getSurveySubmissionQuestionSections**
> GetSurveySections200Response getSurveySubmissionQuestionSections()

Returns the survey\'s sections along with their questions and answer choices for a specific submission, used to render the full submission form, requiring read permission on surveys.

### Example

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

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

let surveyId: string; //The survey identifier (default to undefined)
let submissionId: string; //The submission 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.getSurveySubmissionQuestionSections(
    surveyId,
    submissionId,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **surveyId** | [**string**] | The survey identifier | defaults to undefined|
| **submissionId** | [**string**] | The submission 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

**GetSurveySections200Response**

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

# **getSurveySubmissionResponseChanges**
> GetSurveySubmissionResponseChanges200Response getSurveySubmissionResponseChanges()

Returns a paginated audit trail of changes made to a specific question\'s response within a survey submission, with optional search and ordering, requiring read permission on surveys.

### Example

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

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

let surveyId: string; //The survey identifier (default to undefined)
let submissionId: string; //The submission 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.getSurveySubmissionResponseChanges(
    surveyId,
    submissionId,
    questionId,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **surveyId** | [**string**] | The survey identifier | defaults to undefined|
| **submissionId** | [**string**] | The submission 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

**GetSurveySubmissionResponseChanges200Response**

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

# **getSurveySubmissions**
> GetSurveySubmissions200Response getSurveySubmissions()

Returns a paginated list of submissions for a survey, optionally filtered by purchase status, with search and ordering support, requiring read permission on surveys.

### Example

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

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

let surveyId: string; //The survey identifier (default to undefined)
let status: PurchaseStatus; //Filter by status (optional) (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.getSurveySubmissions(
    surveyId,
    status,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **surveyId** | [**string**] | The survey identifier | defaults to undefined|
| **status** | **PurchaseStatus** | Filter by status | (optional) 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

**GetSurveySubmissions200Response**

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

# **updateSurveySubmission**
> GetSurveySubmission200Response updateSurveySubmission(surveySubmissionUpdateInputs)

Updates a survey submission\'s status (e.g. flagging it as needing info), or its associated account or event pass; requires the update surveys permission.

### Example

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

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

let surveyId: string; //The survey identifier (default to undefined)
let submissionId: string; //The submission identifier (default to undefined)
let surveySubmissionUpdateInputs: SurveySubmissionUpdateInputs; //

const { status, data } = await apiInstance.updateSurveySubmission(
    surveyId,
    submissionId,
    surveySubmissionUpdateInputs
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **surveySubmissionUpdateInputs** | **SurveySubmissionUpdateInputs**|  | |
| **surveyId** | [**string**] | The survey identifier | defaults to undefined|
| **submissionId** | [**string**] | The submission identifier | defaults to undefined|


### Return type

**GetSurveySubmission200Response**

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

# **updateSurveySubmissionResponses**
> CreateAccountInvitations200Response updateSurveySubmissionResponses(requestBody)

Overwrites all of a survey submission\'s question responses with the provided question/value pairs, discarding any prior answers to that submission; requires the update surveys permission.

### Example

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

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

let surveyId: string; //The survey identifier (default to undefined)
let submissionId: string; //The submission identifier (default to undefined)
let requestBody: Array<object>; //

const { status, data } = await apiInstance.updateSurveySubmissionResponses(
    surveyId,
    submissionId,
    requestBody
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **requestBody** | **Array<object>**|  | |
| **surveyId** | [**string**] | The survey identifier | defaults to undefined|
| **submissionId** | [**string**] | The submission identifier | defaults to undefined|


### Return type

**CreateAccountInvitations200Response**

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