Reference for http://vismaaddo.net/WebService/v2.0/RestSigningService.svc/GetFormResponse?token={TOKEN}&transactionToken={TRANSACTIONTOKEN}
Url: http://vismaaddo.net/WebService/v2.0/RestSigningService.svc/GetFormResponse?token={TOKEN}&transactionToken={TRANSACTIONTOKEN}
HTTP Method: GET
Message direction | Format | Body |
---|---|---|
Request | N/A | The Request body is empty. |
Response | Xml | Example,Schema |
Response | Json | Example |
The following is an example response Xml body:
<GetFormResponse xmlns="http://schemas.vismaaddo.net/services/signingservice/v2_0/messages/getformresponse"> <Components xmlns="http://schemas.vismaaddo.net/services/signingservice/v2_0/messages/getformbaseresponse"> <GetFormBaseResponse.FormComponentForView xmlns="http://schemas.vismaaddo.net/services/signingservice/v2_0/messages/getformbaseresponse/formcomponentforview"> <DataMappingId>String content</DataMappingId> <DependsOn>1627aea5-8e0a-4371-9022-9b504344e724</DependsOn> <Id>1627aea5-8e0a-4371-9022-9b504344e724</Id> <Label>String content</Label> <Locked>true</Locked> <Order>2147483647</Order> <ParentId>1627aea5-8e0a-4371-9022-9b504344e724</ParentId> <Required>true</Required> <Type>Section</Type> <Value>String content</Value> </GetFormBaseResponse.FormComponentForView> <GetFormBaseResponse.FormComponentForView xmlns="http://schemas.vismaaddo.net/services/signingservice/v2_0/messages/getformbaseresponse/formcomponentforview"> <DataMappingId>String content</DataMappingId> <DependsOn>1627aea5-8e0a-4371-9022-9b504344e724</DependsOn> <Id>1627aea5-8e0a-4371-9022-9b504344e724</Id> <Label>String content</Label> <Locked>true</Locked> <Order>2147483647</Order> <ParentId>1627aea5-8e0a-4371-9022-9b504344e724</ParentId> <Required>true</Required> <Type>Section</Type> <Value>String content</Value> </GetFormBaseResponse.FormComponentForView> </Components> </GetFormResponse>
The following is an example response Json body:
{ "Components":[{ "DataMappingId":"String content", "DependsOn":"1627aea5-8e0a-4371-9022-9b504344e724", "Id":"1627aea5-8e0a-4371-9022-9b504344e724", "Label":"String content", "Locked":true, "Order":2147483647, "ParentId":"1627aea5-8e0a-4371-9022-9b504344e724", "Required":true, "Type":0, "Value":"String content" }] }
The following is the response Xml Schema:
<xs:schema xmlns:tns="http://schemas.vismaaddo.net/services/signingservice/v2_0/messages/getformresponse" elementFormDefault="qualified" targetNamespace="http://schemas.vismaaddo.net/services/signingservice/v2_0/messages/getformresponse" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:import namespace="http://schemas.vismaaddo.net/services/signingservice/v2_0/messages/getformbaseresponse" /> <xs:complexType name="GetFormResponse"> <xs:complexContent mixed="false"> <xs:extension xmlns:q1="http://schemas.vismaaddo.net/services/signingservice/v2_0/messages/getformbaseresponse" base="q1:GetFormBaseResponse"> <xs:sequence /> </xs:extension> </xs:complexContent> </xs:complexType> <xs:element name="GetFormResponse" nillable="true" type="tns:GetFormResponse" /> </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.vismaaddo.net/services/signingservice/v2_0/messages/getformbaseresponse" elementFormDefault="qualified" targetNamespace="http://schemas.vismaaddo.net/services/signingservice/v2_0/messages/getformbaseresponse" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:import namespace="http://schemas.vismaaddo.net/services/signingservice/v2_0/messages/getformbaseresponse/formcomponentforview" /> <xs:complexType name="GetFormBaseResponse"> <xs:sequence> <xs:element minOccurs="0" name="Components" nillable="true" xmlns:q1="http://schemas.vismaaddo.net/services/signingservice/v2_0/messages/getformbaseresponse/formcomponentforview" type="q1:ArrayOfGetFormBaseResponse.FormComponentForView" /> </xs:sequence> </xs:complexType> <xs:element name="GetFormBaseResponse" nillable="true" type="tns:GetFormBaseResponse" /> </xs:schema>
<xs:schema xmlns:tns="http://schemas.vismaaddo.net/services/signingservice/v2_0/messages/getformbaseresponse/formcomponentforview" xmlns:ser="http://schemas.microsoft.com/2003/10/Serialization/" elementFormDefault="qualified" targetNamespace="http://schemas.vismaaddo.net/services/signingservice/v2_0/messages/getformbaseresponse/formcomponentforview" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:import namespace="http://schemas.microsoft.com/2003/10/Serialization/" /> <xs:import namespace="http://schemas.datacontract.org/2004/07/Visma.Addo.Model.Entities.Enums" /> <xs:complexType name="ArrayOfGetFormBaseResponse.FormComponentForView"> <xs:sequence> <xs:element minOccurs="0" maxOccurs="unbounded" name="GetFormBaseResponse.FormComponentForView" nillable="true" type="tns:GetFormBaseResponse.FormComponentForView" /> </xs:sequence> </xs:complexType> <xs:element name="ArrayOfGetFormBaseResponse.FormComponentForView" nillable="true" type="tns:ArrayOfGetFormBaseResponse.FormComponentForView" /> <xs:complexType name="GetFormBaseResponse.FormComponentForView"> <xs:sequence> <xs:element minOccurs="0" name="DataMappingId" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="DependsOn" nillable="true" type="ser:guid" /> <xs:element minOccurs="0" name="Id" type="ser:guid" /> <xs:element minOccurs="0" name="Label" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Locked" type="xs:boolean" /> <xs:element minOccurs="0" name="Order" type="xs:int" /> <xs:element minOccurs="0" name="ParentId" nillable="true" type="ser:guid" /> <xs:element minOccurs="0" name="Required" type="xs:boolean" /> <xs:element minOccurs="0" name="Type" xmlns:q1="http://schemas.datacontract.org/2004/07/Visma.Addo.Model.Entities.Enums" type="q1:ComponentType" /> <xs:element minOccurs="0" name="Value" nillable="true" type="xs:string" /> </xs:sequence> </xs:complexType> <xs:element name="GetFormBaseResponse.FormComponentForView" nillable="true" type="tns:GetFormBaseResponse.FormComponentForView" /> </xs:schema>
<xs:schema xmlns:tns="http://schemas.datacontract.org/2004/07/Visma.Addo.Model.Entities.Enums" elementFormDefault="qualified" targetNamespace="http://schemas.datacontract.org/2004/07/Visma.Addo.Model.Entities.Enums" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:import namespace="http://schemas.microsoft.com/2003/10/Serialization/" /> <xs:simpleType name="ComponentType"> <xs:restriction base="xs:string"> <xs:enumeration value="Section"> <xs:annotation> <xs:appinfo> <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1</EnumerationValue> </xs:appinfo> </xs:annotation> </xs:enumeration> <xs:enumeration value="TextInput"> <xs:annotation> <xs:appinfo> <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">2</EnumerationValue> </xs:appinfo> </xs:annotation> </xs:enumeration> <xs:enumeration value="TextArea"> <xs:annotation> <xs:appinfo> <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">3</EnumerationValue> </xs:appinfo> </xs:annotation> </xs:enumeration> <xs:enumeration value="RadioGroup"> <xs:annotation> <xs:appinfo> <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">4</EnumerationValue> </xs:appinfo> </xs:annotation> </xs:enumeration> <xs:enumeration value="RadioOption"> <xs:annotation> <xs:appinfo> <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">5</EnumerationValue> </xs:appinfo> </xs:annotation> </xs:enumeration> <xs:enumeration value="Text"> <xs:annotation> <xs:appinfo> <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">6</EnumerationValue> </xs:appinfo> </xs:annotation> </xs:enumeration> <xs:enumeration value="Title"> <xs:annotation> <xs:appinfo> <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">7</EnumerationValue> </xs:appinfo> </xs:annotation> </xs:enumeration> <xs:enumeration value="Checkbox"> <xs:annotation> <xs:appinfo> <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">8</EnumerationValue> </xs:appinfo> </xs:annotation> </xs:enumeration> <xs:enumeration value="CheckboxGroup"> <xs:annotation> <xs:appinfo> <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">9</EnumerationValue> </xs:appinfo> </xs:annotation> </xs:enumeration> <xs:enumeration value="File"> <xs:annotation> <xs:appinfo> <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">10</EnumerationValue> </xs:appinfo> </xs:annotation> </xs:enumeration> <xs:enumeration value="Datepicker"> <xs:annotation> <xs:appinfo> <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">11</EnumerationValue> </xs:appinfo> </xs:annotation> </xs:enumeration> <xs:enumeration value="Image"> <xs:annotation> <xs:appinfo> <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">12</EnumerationValue> </xs:appinfo> </xs:annotation> </xs:enumeration> <xs:enumeration value="ImageFormat"> <xs:annotation> <xs:appinfo> <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">13</EnumerationValue> </xs:appinfo> </xs:annotation> </xs:enumeration> <xs:enumeration value="ImageAlignment"> <xs:annotation> <xs:appinfo> <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">14</EnumerationValue> </xs:appinfo> </xs:annotation> </xs:enumeration> </xs:restriction> </xs:simpleType> <xs:element name="ComponentType" nillable="true" type="tns:ComponentType" /> </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>