GET example/api/survey/{id}/responses
https://app.bwz.se/bedrock/example/api/survey/{id}/responses
Gets all responses for a certain Survey.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Collection of FormResponseModelName | Description | Type | Additional information |
---|---|---|---|
FormFieldResponses |
Responses for every field of the FormResponse. |
Collection of FormFieldResponseModel |
None. |
ResponseDate |
ResponseDate of the FormResponse. |
date |
None. |
MailRecipientId |
Id of the responding MailRecipient. |
integer |
None. |
FormResponseId |
Id of the FormResponse. |
integer |
None. |
SignupStatus |
Form response signup status. |
FormResponseTypes |
None. |
SignupStatusText |
Form response signup status as text. |
string |
None. |
Response Formats
application/json, text/json
Sample:
[ { "FormFieldResponses": [ { "FormField": { "FormFieldId": 1, "Name": "sample string 2", "FieldType": 1, "IsRequired": true, "FieldDataType": 1, "FieldLabel": "sample string 4", "Options": [ { "Value": "sample string 1", "Label": "sample string 2" }, { "Value": "sample string 1", "Label": "sample string 2" } ] }, "FormResponseValue": { "Name": "sample string 1", "Values": [ "sample string 1", "sample string 2" ], "ResponseFormFieldPossiblities": [ { "Value": "sample string 1", "Label": "sample string 2" }, { "Value": "sample string 1", "Label": "sample string 2" } ] } }, { "FormField": { "FormFieldId": 1, "Name": "sample string 2", "FieldType": 1, "IsRequired": true, "FieldDataType": 1, "FieldLabel": "sample string 4", "Options": [ { "Value": "sample string 1", "Label": "sample string 2" }, { "Value": "sample string 1", "Label": "sample string 2" } ] }, "FormResponseValue": { "Name": "sample string 1", "Values": [ "sample string 1", "sample string 2" ], "ResponseFormFieldPossiblities": [ { "Value": "sample string 1", "Label": "sample string 2" }, { "Value": "sample string 1", "Label": "sample string 2" } ] } } ], "ResponseDate": "2024-12-23T06:21:28.2966131+01:00", "MailRecipientId": 1, "FormResponseId": 2, "SignupStatus": 0, "SignupStatusText": "Default" }, { "FormFieldResponses": [ { "FormField": { "FormFieldId": 1, "Name": "sample string 2", "FieldType": 1, "IsRequired": true, "FieldDataType": 1, "FieldLabel": "sample string 4", "Options": [ { "Value": "sample string 1", "Label": "sample string 2" }, { "Value": "sample string 1", "Label": "sample string 2" } ] }, "FormResponseValue": { "Name": "sample string 1", "Values": [ "sample string 1", "sample string 2" ], "ResponseFormFieldPossiblities": [ { "Value": "sample string 1", "Label": "sample string 2" }, { "Value": "sample string 1", "Label": "sample string 2" } ] } }, { "FormField": { "FormFieldId": 1, "Name": "sample string 2", "FieldType": 1, "IsRequired": true, "FieldDataType": 1, "FieldLabel": "sample string 4", "Options": [ { "Value": "sample string 1", "Label": "sample string 2" }, { "Value": "sample string 1", "Label": "sample string 2" } ] }, "FormResponseValue": { "Name": "sample string 1", "Values": [ "sample string 1", "sample string 2" ], "ResponseFormFieldPossiblities": [ { "Value": "sample string 1", "Label": "sample string 2" }, { "Value": "sample string 1", "Label": "sample string 2" } ] } } ], "ResponseDate": "2024-12-23T06:21:28.2966131+01:00", "MailRecipientId": 1, "FormResponseId": 2, "SignupStatus": 0, "SignupStatusText": "Default" } ]
application/xml, text/xml
Sample:
<ArrayOfFormResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Netoptions.BizWizard.Api.Common.Models.Form"> <FormResponseModel> <FormFieldResponses> <FormFieldResponseModel> <FormField> <FieldDataType>Text</FieldDataType> <FieldLabel>sample string 4</FieldLabel> <FieldType>TEXT</FieldType> <FormFieldId>1</FormFieldId> <IsRequired>true</IsRequired> <Name>sample string 2</Name> <Options> <FormFieldPossibilityModel> <Label>sample string 2</Label> <Value>sample string 1</Value> </FormFieldPossibilityModel> <FormFieldPossibilityModel> <Label>sample string 2</Label> <Value>sample string 1</Value> </FormFieldPossibilityModel> </Options> </FormField> <FormResponseValue> <Name>sample string 1</Name> <ResponseFormFieldPossiblities> <FormFieldPossibilityModel> <Label>sample string 2</Label> <Value>sample string 1</Value> </FormFieldPossibilityModel> <FormFieldPossibilityModel> <Label>sample string 2</Label> <Value>sample string 1</Value> </FormFieldPossibilityModel> </ResponseFormFieldPossiblities> <Values xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d6p1:string>sample string 1</d6p1:string> <d6p1:string>sample string 2</d6p1:string> </Values> </FormResponseValue> </FormFieldResponseModel> <FormFieldResponseModel> <FormField> <FieldDataType>Text</FieldDataType> <FieldLabel>sample string 4</FieldLabel> <FieldType>TEXT</FieldType> <FormFieldId>1</FormFieldId> <IsRequired>true</IsRequired> <Name>sample string 2</Name> <Options> <FormFieldPossibilityModel> <Label>sample string 2</Label> <Value>sample string 1</Value> </FormFieldPossibilityModel> <FormFieldPossibilityModel> <Label>sample string 2</Label> <Value>sample string 1</Value> </FormFieldPossibilityModel> </Options> </FormField> <FormResponseValue> <Name>sample string 1</Name> <ResponseFormFieldPossiblities> <FormFieldPossibilityModel> <Label>sample string 2</Label> <Value>sample string 1</Value> </FormFieldPossibilityModel> <FormFieldPossibilityModel> <Label>sample string 2</Label> <Value>sample string 1</Value> </FormFieldPossibilityModel> </ResponseFormFieldPossiblities> <Values xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d6p1:string>sample string 1</d6p1:string> <d6p1:string>sample string 2</d6p1:string> </Values> </FormResponseValue> </FormFieldResponseModel> </FormFieldResponses> <FormResponseId>2</FormResponseId> <MailRecipientId>1</MailRecipientId> <ResponseDate>2024-12-23T06:21:28.2966131+01:00</ResponseDate> <SignupStatus>Default</SignupStatus> </FormResponseModel> <FormResponseModel> <FormFieldResponses> <FormFieldResponseModel> <FormField> <FieldDataType>Text</FieldDataType> <FieldLabel>sample string 4</FieldLabel> <FieldType>TEXT</FieldType> <FormFieldId>1</FormFieldId> <IsRequired>true</IsRequired> <Name>sample string 2</Name> <Options> <FormFieldPossibilityModel> <Label>sample string 2</Label> <Value>sample string 1</Value> </FormFieldPossibilityModel> <FormFieldPossibilityModel> <Label>sample string 2</Label> <Value>sample string 1</Value> </FormFieldPossibilityModel> </Options> </FormField> <FormResponseValue> <Name>sample string 1</Name> <ResponseFormFieldPossiblities> <FormFieldPossibilityModel> <Label>sample string 2</Label> <Value>sample string 1</Value> </FormFieldPossibilityModel> <FormFieldPossibilityModel> <Label>sample string 2</Label> <Value>sample string 1</Value> </FormFieldPossibilityModel> </ResponseFormFieldPossiblities> <Values xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d6p1:string>sample string 1</d6p1:string> <d6p1:string>sample string 2</d6p1:string> </Values> </FormResponseValue> </FormFieldResponseModel> <FormFieldResponseModel> <FormField> <FieldDataType>Text</FieldDataType> <FieldLabel>sample string 4</FieldLabel> <FieldType>TEXT</FieldType> <FormFieldId>1</FormFieldId> <IsRequired>true</IsRequired> <Name>sample string 2</Name> <Options> <FormFieldPossibilityModel> <Label>sample string 2</Label> <Value>sample string 1</Value> </FormFieldPossibilityModel> <FormFieldPossibilityModel> <Label>sample string 2</Label> <Value>sample string 1</Value> </FormFieldPossibilityModel> </Options> </FormField> <FormResponseValue> <Name>sample string 1</Name> <ResponseFormFieldPossiblities> <FormFieldPossibilityModel> <Label>sample string 2</Label> <Value>sample string 1</Value> </FormFieldPossibilityModel> <FormFieldPossibilityModel> <Label>sample string 2</Label> <Value>sample string 1</Value> </FormFieldPossibilityModel> </ResponseFormFieldPossiblities> <Values xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d6p1:string>sample string 1</d6p1:string> <d6p1:string>sample string 2</d6p1:string> </Values> </FormResponseValue> </FormFieldResponseModel> </FormFieldResponses> <FormResponseId>2</FormResponseId> <MailRecipientId>1</MailRecipientId> <ResponseDate>2024-12-23T06:21:28.2966131+01:00</ResponseDate> <SignupStatus>Default</SignupStatus> </FormResponseModel> </ArrayOfFormResponseModel>