Reference for http://ws.veriscanonline.com/VSWebServices67/ActiveSurveys
Return active or completed surveys with questions
Url: http://ws.veriscanonline.com/VSWebServices67/ActiveSurveys
HTTP Method: POST
Message direction | Format | Body |
---|---|---|
Request | Xml | Example,Schema |
Request | Json | Example |
Response | Xml | Example,Schema |
Response | Json | Example |
The following is an example request Xml body:
<SurveysRequestModel xmlns="http://schemas.datacontract.org/2004/07/VSWebService.Models.Surveys"> <AppVersion xmlns="http://schemas.datacontract.org/2004/07/VSWebService.Models.Common">String content</AppVersion> <CompanyId xmlns="http://schemas.datacontract.org/2004/07/VSWebService.Models.Common">String content</CompanyId> <ComputerName xmlns="http://schemas.datacontract.org/2004/07/VSWebService.Models.Common">String content</ComputerName> <HardwareId xmlns="http://schemas.datacontract.org/2004/07/VSWebService.Models.Common">String content</HardwareId> <IsLive xmlns="http://schemas.datacontract.org/2004/07/VSWebService.Models.Common">true</IsLive> <TimeZoneId xmlns="http://schemas.datacontract.org/2004/07/VSWebService.Models.Common">String content</TimeZoneId> <UserId xmlns="http://schemas.datacontract.org/2004/07/VSWebService.Models.Common">2147483647</UserId> <Login xmlns="http://schemas.datacontract.org/2004/07/VSWebService.Models.Common">String content</Login> <Password xmlns="http://schemas.datacontract.org/2004/07/VSWebService.Models.Common">String content</Password> <CardId>2147483647</CardId> </SurveysRequestModel>
The following is an example request Json body:
{ "AppVersion":"String content", "CompanyId":"String content", "ComputerName":"String content", "HardwareId":"String content", "IsLive":true, "TimeZoneId":"String content", "UserId":2147483647, "Login":"String content", "Password":"String content", "CardId":2147483647 }
The following is an example response Xml body:
<SurveysResponseModel xmlns="http://schemas.datacontract.org/2004/07/VSWebService.Models.Surveys"> <ErrorCode xmlns="http://schemas.datacontract.org/2004/07/VSWebService.Models.Common">String content</ErrorCode> <Status xmlns="http://schemas.datacontract.org/2004/07/VSWebService.Models.Common">String content</Status> <StatusCode xmlns="http://schemas.datacontract.org/2004/07/VSWebService.Models.Common">2147483647</StatusCode> <ValidationResult xmlns="http://schemas.datacontract.org/2004/07/VSWebService.Models.Common"> <ResponseValidationResultItem> <Errors> <string xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">String content</string> <string xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">String content</string> </Errors> <Field>String content</Field> </ResponseValidationResultItem> <ResponseValidationResultItem> <Errors> <string xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">String content</string> <string xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">String content</string> </Errors> <Field>String content</Field> </ResponseValidationResultItem> </ValidationResult> <AllowEditSurvey>true</AllowEditSurvey> <Surveys> <SurveyResponseModel> <AlreadyCompleted>true</AlreadyCompleted> <CreatedUtc>1999-05-31T11:20:00</CreatedUtc> <Questions> <SurveyResponseModel.Question> <AnswerValues> <string xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">String content</string> <string xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">String content</string> </AnswerValues> <Answers> <SurveyResponseModel.Question.Answer> <AnswerId>2147483647</AnswerId> <Text>String content</Text> </SurveyResponseModel.Question.Answer> <SurveyResponseModel.Question.Answer> <AnswerId>2147483647</AnswerId> <Text>String content</Text> </SurveyResponseModel.Question.Answer> </Answers> <QuestionId>2147483647</QuestionId> <QuestionText>String content</QuestionText> <QuestionType>2147483647</QuestionType> </SurveyResponseModel.Question> <SurveyResponseModel.Question> <AnswerValues> <string xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">String content</string> <string xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">String content</string> </AnswerValues> <Answers> <SurveyResponseModel.Question.Answer> <AnswerId>2147483647</AnswerId> <Text>String content</Text> </SurveyResponseModel.Question.Answer> <SurveyResponseModel.Question.Answer> <AnswerId>2147483647</AnswerId> <Text>String content</Text> </SurveyResponseModel.Question.Answer> </Answers> <QuestionId>2147483647</QuestionId> <QuestionText>String content</QuestionText> <QuestionType>2147483647</QuestionType> </SurveyResponseModel.Question> </Questions> <SurveyId>2147483647</SurveyId> <SurveyName>String content</SurveyName> </SurveyResponseModel> <SurveyResponseModel> <AlreadyCompleted>true</AlreadyCompleted> <CreatedUtc>1999-05-31T11:20:00</CreatedUtc> <Questions> <SurveyResponseModel.Question> <AnswerValues> <string xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">String content</string> <string xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">String content</string> </AnswerValues> <Answers> <SurveyResponseModel.Question.Answer> <AnswerId>2147483647</AnswerId> <Text>String content</Text> </SurveyResponseModel.Question.Answer> <SurveyResponseModel.Question.Answer> <AnswerId>2147483647</AnswerId> <Text>String content</Text> </SurveyResponseModel.Question.Answer> </Answers> <QuestionId>2147483647</QuestionId> <QuestionText>String content</QuestionText> <QuestionType>2147483647</QuestionType> </SurveyResponseModel.Question> <SurveyResponseModel.Question> <AnswerValues> <string xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">String content</string> <string xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">String content</string> </AnswerValues> <Answers> <SurveyResponseModel.Question.Answer> <AnswerId>2147483647</AnswerId> <Text>String content</Text> </SurveyResponseModel.Question.Answer> <SurveyResponseModel.Question.Answer> <AnswerId>2147483647</AnswerId> <Text>String content</Text> </SurveyResponseModel.Question.Answer> </Answers> <QuestionId>2147483647</QuestionId> <QuestionText>String content</QuestionText> <QuestionType>2147483647</QuestionType> </SurveyResponseModel.Question> </Questions> <SurveyId>2147483647</SurveyId> <SurveyName>String content</SurveyName> </SurveyResponseModel> </Surveys> </SurveysResponseModel>
The following is an example response Json body:
{ "ErrorCode":"String content", "Status":"String content", "StatusCode":2147483647, "ValidationResult":[{ "Errors":["String content"], "Field":"String content" }], "AllowEditSurvey":true, "Surveys":[{ "AlreadyCompleted":true, "CreatedUtc":"\/Date(928149600000+0000)\/", "Questions":[{ "AnswerValues":["String content"], "Answers":[{ "AnswerId":2147483647, "Text":"String content" }], "QuestionId":2147483647, "QuestionText":"String content", "QuestionType":2147483647 }], "SurveyId":2147483647, "SurveyName":"String content" }] }
The following is the request Xml Schema:
<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/VSWebService.Models.Surveys" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/VSWebService.Models.Surveys" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:import namespace="http://schemas.datacontract.org/2004/07/VSWebService.Models.Common" /> <xs:complexType name="SurveysRequestModel"> <xs:complexContent mixed="false"> <xs:extension xmlns:q1="http://schemas.datacontract.org/2004/07/VSWebService.Models.Common" base="q1:RequestModel"> <xs:sequence> <xs:element minOccurs="0" name="CardId" type="xs:int" /> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> <xs:element name="SurveysRequestModel" nillable="true" type="tns:SurveysRequestModel" /> </xs:schema>
Additional request Xml Schemas:
<xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/" attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:element name="anyType" nillable="true" type="xs:anyType" /> <xs:element name="anyURI" nillable="true" type="xs:anyURI" /> <xs:element name="base64Binary" nillable="true" type="xs:base64Binary" /> <xs:element name="boolean" nillable="true" type="xs:boolean" /> <xs:element name="byte" nillable="true" type="xs:byte" /> <xs:element name="dateTime" nillable="true" type="xs:dateTime" /> <xs:element name="decimal" nillable="true" type="xs:decimal" /> <xs:element name="double" nillable="true" type="xs:double" /> <xs:element name="float" nillable="true" type="xs:float" /> <xs:element name="int" nillable="true" type="xs:int" /> <xs:element name="long" nillable="true" type="xs:long" /> <xs:element name="QName" nillable="true" type="xs:QName" /> <xs:element name="short" nillable="true" type="xs:short" /> <xs:element name="string" nillable="true" type="xs:string" /> <xs:element name="unsignedByte" nillable="true" type="xs:unsignedByte" /> <xs:element name="unsignedInt" nillable="true" type="xs:unsignedInt" /> <xs:element name="unsignedLong" nillable="true" type="xs:unsignedLong" /> <xs:element name="unsignedShort" nillable="true" type="xs:unsignedShort" /> <xs:element name="char" nillable="true" type="tns:char" /> <xs:simpleType name="char"> <xs:restriction base="xs:int" /> </xs:simpleType> <xs:element name="duration" nillable="true" type="tns:duration" /> <xs:simpleType name="duration"> <xs:restriction base="xs:duration"> <xs:pattern value="\-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?" /> <xs:minInclusive value="-P10675199DT2H48M5.4775808S" /> <xs:maxInclusive value="P10675199DT2H48M5.4775807S" /> </xs:restriction> </xs:simpleType> <xs:element name="guid" nillable="true" type="tns:guid" /> <xs:simpleType name="guid"> <xs:restriction base="xs:string"> <xs:pattern value="[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}" /> </xs:restriction> </xs:simpleType> <xs:attribute name="FactoryType" type="xs:QName" /> <xs:attribute name="Id" type="xs:ID" /> <xs:attribute name="Ref" type="xs:IDREF" /> </xs:schema>
<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/VSWebService.Models.Common" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/VSWebService.Models.Common" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:complexType name="RequestModel"> <xs:complexContent mixed="false"> <xs:extension base="tns:RequestModelBase"> <xs:sequence> <xs:element minOccurs="0" name="Login" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Password" nillable="true" type="xs:string" /> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> <xs:element name="RequestModel" nillable="true" type="tns:RequestModel" /> <xs:complexType name="RequestModelBase"> <xs:sequence> <xs:element minOccurs="0" name="AppVersion" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="CompanyId" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="ComputerName" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="HardwareId" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="IsLive" type="xs:boolean" /> <xs:element minOccurs="0" name="TimeZoneId" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="UserId" nillable="true" type="xs:int" /> </xs:sequence> </xs:complexType> <xs:element name="RequestModelBase" nillable="true" type="tns:RequestModelBase" /> </xs:schema>
<tns:schema targetNamespace="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://www.w3.org/2001/XMLSchema"> <tns:element name="schema"> <tns:complexType /> </tns:element> </tns:schema>
The following is the response Xml Schema:
<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/VSWebService.Models.Surveys" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/VSWebService.Models.Surveys" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:import namespace="http://schemas.datacontract.org/2004/07/VSWebService.Models.Common" /> <xs:import namespace="http://schemas.microsoft.com/2003/10/Serialization/Arrays" /> <xs:complexType name="SurveysResponseModel"> <xs:complexContent mixed="false"> <xs:extension xmlns:q1="http://schemas.datacontract.org/2004/07/VSWebService.Models.Common" base="q1:ResponseModel"> <xs:sequence> <xs:element minOccurs="0" name="AllowEditSurvey" type="xs:boolean" /> <xs:element minOccurs="0" name="Surveys" nillable="true" type="tns:ArrayOfSurveyResponseModel" /> </xs:sequence> </xs:extension> </xs:complexContent> </xs:complexType> <xs:element name="SurveysResponseModel" nillable="true" type="tns:SurveysResponseModel" /> <xs:complexType name="ArrayOfSurveyResponseModel"> <xs:sequence> <xs:element minOccurs="0" maxOccurs="unbounded" name="SurveyResponseModel" nillable="true" type="tns:SurveyResponseModel" /> </xs:sequence> </xs:complexType> <xs:element name="ArrayOfSurveyResponseModel" nillable="true" type="tns:ArrayOfSurveyResponseModel" /> <xs:complexType name="SurveyResponseModel"> <xs:sequence> <xs:element minOccurs="0" name="AlreadyCompleted" type="xs:boolean" /> <xs:element minOccurs="0" name="CreatedUtc" nillable="true" type="xs:dateTime" /> <xs:element minOccurs="0" name="Questions" nillable="true" type="tns:ArrayOfSurveyResponseModel.Question" /> <xs:element minOccurs="0" name="SurveyId" type="xs:int" /> <xs:element minOccurs="0" name="SurveyName" nillable="true" type="xs:string" /> </xs:sequence> </xs:complexType> <xs:element name="SurveyResponseModel" nillable="true" type="tns:SurveyResponseModel" /> <xs:complexType name="ArrayOfSurveyResponseModel.Question"> <xs:sequence> <xs:element minOccurs="0" maxOccurs="unbounded" name="SurveyResponseModel.Question" nillable="true" type="tns:SurveyResponseModel.Question" /> </xs:sequence> </xs:complexType> <xs:element name="ArrayOfSurveyResponseModel.Question" nillable="true" type="tns:ArrayOfSurveyResponseModel.Question" /> <xs:complexType name="SurveyResponseModel.Question"> <xs:sequence> <xs:element minOccurs="0" name="AnswerValues" nillable="true" xmlns:q2="http://schemas.microsoft.com/2003/10/Serialization/Arrays" type="q2:ArrayOfstring" /> <xs:element minOccurs="0" name="Answers" nillable="true" type="tns:ArrayOfSurveyResponseModel.Question.Answer" /> <xs:element minOccurs="0" name="QuestionId" type="xs:int" /> <xs:element minOccurs="0" name="QuestionText" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="QuestionType" type="xs:int" /> </xs:sequence> </xs:complexType> <xs:element name="SurveyResponseModel.Question" nillable="true" type="tns:SurveyResponseModel.Question" /> <xs:complexType name="ArrayOfSurveyResponseModel.Question.Answer"> <xs:sequence> <xs:element minOccurs="0" maxOccurs="unbounded" name="SurveyResponseModel.Question.Answer" nillable="true" type="tns:SurveyResponseModel.Question.Answer" /> </xs:sequence> </xs:complexType> <xs:element name="ArrayOfSurveyResponseModel.Question.Answer" nillable="true" type="tns:ArrayOfSurveyResponseModel.Question.Answer" /> <xs:complexType name="SurveyResponseModel.Question.Answer"> <xs:sequence> <xs:element minOccurs="0" name="AnswerId" type="xs:int" /> <xs:element minOccurs="0" name="Text" nillable="true" type="xs:string" /> </xs:sequence> </xs:complexType> <xs:element name="SurveyResponseModel.Question.Answer" nillable="true" type="tns:SurveyResponseModel.Question.Answer" /> </xs:schema>
Additional response Xml Schemas:
<xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/" attributeFormDefault="qualified" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:element name="anyType" nillable="true" type="xs:anyType" /> <xs:element name="anyURI" nillable="true" type="xs:anyURI" /> <xs:element name="base64Binary" nillable="true" type="xs:base64Binary" /> <xs:element name="boolean" nillable="true" type="xs:boolean" /> <xs:element name="byte" nillable="true" type="xs:byte" /> <xs:element name="dateTime" nillable="true" type="xs:dateTime" /> <xs:element name="decimal" nillable="true" type="xs:decimal" /> <xs:element name="double" nillable="true" type="xs:double" /> <xs:element name="float" nillable="true" type="xs:float" /> <xs:element name="int" nillable="true" type="xs:int" /> <xs:element name="long" nillable="true" type="xs:long" /> <xs:element name="QName" nillable="true" type="xs:QName" /> <xs:element name="short" nillable="true" type="xs:short" /> <xs:element name="string" nillable="true" type="xs:string" /> <xs:element name="unsignedByte" nillable="true" type="xs:unsignedByte" /> <xs:element name="unsignedInt" nillable="true" type="xs:unsignedInt" /> <xs:element name="unsignedLong" nillable="true" type="xs:unsignedLong" /> <xs:element name="unsignedShort" nillable="true" type="xs:unsignedShort" /> <xs:element name="char" nillable="true" type="tns:char" /> <xs:simpleType name="char"> <xs:restriction base="xs:int" /> </xs:simpleType> <xs:element name="duration" nillable="true" type="tns:duration" /> <xs:simpleType name="duration"> <xs:restriction base="xs:duration"> <xs:pattern value="\-?P(\d*D)?(T(\d*H)?(\d*M)?(\d*(\.\d*)?S)?)?" /> <xs:minInclusive value="-P10675199DT2H48M5.4775808S" /> <xs:maxInclusive value="P10675199DT2H48M5.4775807S" /> </xs:restriction> </xs:simpleType> <xs:element name="guid" nillable="true" type="tns:guid" /> <xs:simpleType name="guid"> <xs:restriction base="xs:string"> <xs:pattern value="[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}" /> </xs:restriction> </xs:simpleType> <xs:attribute name="FactoryType" type="xs:QName" /> <xs:attribute name="Id" type="xs:ID" /> <xs:attribute name="Ref" type="xs:IDREF" /> </xs:schema>
<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/VSWebService.Models.Common" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/VSWebService.Models.Common" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:import namespace="http://schemas.microsoft.com/2003/10/Serialization/Arrays" /> <xs:complexType name="ResponseModel"> <xs:sequence> <xs:element minOccurs="0" name="ErrorCode" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Status" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="StatusCode" type="xs:int" /> <xs:element minOccurs="0" name="ValidationResult" nillable="true" type="tns:ArrayOfResponseValidationResultItem" /> </xs:sequence> </xs:complexType> <xs:element name="ResponseModel" nillable="true" type="tns:ResponseModel" /> <xs:complexType name="ArrayOfResponseValidationResultItem"> <xs:sequence> <xs:element minOccurs="0" maxOccurs="unbounded" name="ResponseValidationResultItem" nillable="true" type="tns:ResponseValidationResultItem" /> </xs:sequence> </xs:complexType> <xs:element name="ArrayOfResponseValidationResultItem" nillable="true" type="tns:ArrayOfResponseValidationResultItem" /> <xs:complexType name="ResponseValidationResultItem"> <xs:sequence> <xs:element minOccurs="0" name="Errors" nillable="true" xmlns:q1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" type="q1:ArrayOfstring" /> <xs:element minOccurs="0" name="Field" nillable="true" type="xs:string" /> </xs:sequence> </xs:complexType> <xs:element name="ResponseValidationResultItem" nillable="true" type="tns:ResponseValidationResultItem" /> </xs:schema>
<xs:schema xmlns:tns="http://schemas.microsoft.com/2003/10/Serialization/Arrays" elementFormDefault="qualified" targetNamespace="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:complexType name="ArrayOfstring"> <xs:sequence> <xs:element minOccurs="0" maxOccurs="unbounded" name="string" nillable="true" type="xs:string" /> </xs:sequence> </xs:complexType> <xs:element name="ArrayOfstring" nillable="true" type="tns:ArrayOfstring" /> </xs:schema>
<tns:schema targetNamespace="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://www.w3.org/2001/XMLSchema"> <tns:element name="schema"> <tns:complexType /> </tns:element> </tns:schema>