# EventsPassesResponsesApi

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

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**getEventPassResponse**](#geteventpassresponse) | **GET** /events/{eventId}/passes/{passId}/responses/{questionId} | Get an event pass\'s response to a question|
|[**getEventPassResponseChanges**](#geteventpassresponsechanges) | **GET** /events/{eventId}/passes/{passId}/responses/{questionId}/changes | List a pass response\'s edit history|
|[**getEventPassResponses**](#geteventpassresponses) | **GET** /events/{eventId}/passes/{passId}/responses | List a pass\'s registration question responses|
|[**importEventPassResponses**](#importeventpassresponses) | **POST** /events/{eventId}/passes/responses/import | Bulk set registration question answers across many passes|
|[**updateEventPassResponse**](#updateeventpassresponse) | **PUT** /events/{eventId}/passes/{passId}/responses/{questionId} | Update a single registration question response|
|[**updateEventPassResponses**](#updateeventpassresponses) | **PUT** /events/{eventId}/registrations/{registrationId}/passes/{passId}/responses | Update all registration question responses for a pass|

# **getEventPassResponse**
> GetEventPassResponse200Response getEventPassResponse()

Retrieves a single registration question response recorded for the specified event pass, identified by question ID; requires the \"read\" permission on both the \"events\" and \"attendees\" modules.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let passId: string; //The pass identifier (default to undefined)
let questionId: string; //The question identifier (default to undefined)

const { status, data } = await apiInstance.getEventPassResponse(
    eventId,
    passId,
    questionId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **passId** | [**string**] | The pass identifier | defaults to undefined|
| **questionId** | [**string**] | The question identifier | defaults to undefined|


### Return type

**GetEventPassResponse200Response**

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

# **getEventPassResponseChanges**
> GetEventPassResponseChanges200Response getEventPassResponseChanges()

Returns a paginated list of edits made to a single registration question response on an event pass, including the old and new values for each change, and requires the read events and read attendees permissions.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let passId: string; //The pass 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.getEventPassResponseChanges(
    eventId,
    passId,
    questionId,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **passId** | [**string**] | The pass 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

**GetEventPassResponseChanges200Response**

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

# **getEventPassResponses**
> GetEventPassResponses200Response getEventPassResponses()

Returns a paginated list of registration question responses submitted for a specific event pass, supports search by response value, and requires the read events and read attendees permissions.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let passId: string; //The pass 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.getEventPassResponses(
    eventId,
    passId,
    page,
    pageSize,
    orderBy,
    search
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **passId** | [**string**] | The pass 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

**GetEventPassResponses200Response**

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

# **importEventPassResponses**
> ImportEventPassResponses200Response importEventPassResponses(passResponsesImportInputs)

Creates or updates question answers on up to 500 passes in one call, the write half of a CSV import. Each row\'s passId may be a pass id or the pass\'s alternateId. Each questionId must be a question id — question names are not unique on an event, so there is no name fallback. Values are given in the human form the pass export produces: choice questions accept a choice\'s label or id, checkbox cells accept a comma-separated list (use semicolons if a label itself contains a comma), toggles accept yes/no, and dates accept yyyy-MM-dd. File questions cannot be imported. Rows whose pass, question or value cannot be resolved are reported back as invalid and skipped rather than failing the batch. Resolution is synchronous, so every rejected row comes back in the response; the write is queued and runs on the effects side, so the response reports what was accepted rather than what changed. Requires read permission on events and read/update permission on attendees.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let passResponsesImportInputs: PassResponsesImportInputs; //

const { status, data } = await apiInstance.importEventPassResponses(
    eventId,
    passResponsesImportInputs
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **passResponsesImportInputs** | **PassResponsesImportInputs**|  | |
| **eventId** | [**string**] | The event identifier | defaults to undefined|


### Return type

**ImportEventPassResponses200Response**

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

# **updateEventPassResponse**
> GetEventPassResponse200Response updateEventPassResponse(updateEventPassResponseInputs)

Updates the response value for one registration question on the specified event pass, requires read permission on events and read/update permission on attendees.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let passId: string; //The pass identifier (default to undefined)
let questionId: string; //The question identifier (default to undefined)
let updateEventPassResponseInputs: UpdateEventPassResponseInputs; //

const { status, data } = await apiInstance.updateEventPassResponse(
    eventId,
    passId,
    questionId,
    updateEventPassResponseInputs
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **updateEventPassResponseInputs** | **UpdateEventPassResponseInputs**|  | |
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **passId** | [**string**] | The pass identifier | defaults to undefined|
| **questionId** | [**string**] | The question identifier | defaults to undefined|


### Return type

**GetEventPassResponse200Response**

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

# **updateEventPassResponses**
> CreateAccountInvitations200Response updateEventPassResponses(updateEventPassResponsesInputs)

Bulk-updates an attendee\'s registration question responses for the given event pass, requires read permission on events and read/update permission on attendees.

### Example

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

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

let eventId: string; //The event identifier (default to undefined)
let registrationId: string; //The registration identifier (default to undefined)
let passId: string; //The pass identifier (default to undefined)
let updateEventPassResponsesInputs: UpdateEventPassResponsesInputs; //

const { status, data } = await apiInstance.updateEventPassResponses(
    eventId,
    registrationId,
    passId,
    updateEventPassResponsesInputs
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **updateEventPassResponsesInputs** | **UpdateEventPassResponsesInputs**|  | |
| **eventId** | [**string**] | The event identifier | defaults to undefined|
| **registrationId** | [**string**] | The registration identifier | defaults to undefined|
| **passId** | [**string**] | The pass 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)