Reference for http://vismaaddo.net/WebService/v2.0/RestSigningService.svc/GetTemplateMessages?token={TOKEN}&templateId={TEMPLATEID}
Url: http://vismaaddo.net/WebService/v2.0/RestSigningService.svc/GetTemplateMessages?token={TOKEN}&templateId={TEMPLATEID}
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:
<GetTemplateMessagesResponse xmlns="http://schemas.vismaaddo.net/services/signingservice/v2_0/messages/gettemplatemessagesresponse"> <Id>1627aea5-8e0a-4371-9022-9b504344e724</Id> <TemplateMessages> <SigningTemplateMessage xmlns="http://schemas.vismaaddo.net/services/signingservice/v2_0/messages/getsigningtemplatesresponse/SigningTemplate"> <Body>String content</Body> <Subject>String content</Subject> <Type>PdfDocument</Type> <UsageType>StartMessage</UsageType> </SigningTemplateMessage> <SigningTemplateMessage xmlns="http://schemas.vismaaddo.net/services/signingservice/v2_0/messages/getsigningtemplatesresponse/SigningTemplate"> <Body>String content</Body> <Subject>String content</Subject> <Type>PdfDocument</Type> <UsageType>StartMessage</UsageType> </SigningTemplateMessage> </TemplateMessages> </GetTemplateMessagesResponse>
The following is an example response Json body:
{ "Id":"1627aea5-8e0a-4371-9022-9b504344e724", "TemplateMessages":[{ "Body":"String content", "Subject":"String content", "Type":0, "UsageType":0 }] }
The following is the response Xml Schema:
<xs:schema xmlns:tns="http://schemas.vismaaddo.net/services/signingservice/v2_0/messages/gettemplatemessagesresponse" xmlns:ser="http://schemas.microsoft.com/2003/10/Serialization/" elementFormDefault="qualified" targetNamespace="http://schemas.vismaaddo.net/services/signingservice/v2_0/messages/gettemplatemessagesresponse" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:import namespace="http://schemas.microsoft.com/2003/10/Serialization/" /> <xs:import namespace="http://schemas.vismaaddo.net/services/signingservice/v2_0/messages/getsigningtemplatesresponse/SigningTemplate" /> <xs:complexType name="GetTemplateMessagesResponse"> <xs:sequence> <xs:element minOccurs="0" name="Id" type="ser:guid" /> <xs:element minOccurs="0" name="TemplateMessages" nillable="true" xmlns:q1="http://schemas.vismaaddo.net/services/signingservice/v2_0/messages/getsigningtemplatesresponse/SigningTemplate" type="q1:ArrayOfSigningTemplateMessage" /> </xs:sequence> </xs:complexType> <xs:element name="GetTemplateMessagesResponse" nillable="true" type="tns:GetTemplateMessagesResponse" /> </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/getsigningtemplatesresponse/SigningTemplate" elementFormDefault="qualified" targetNamespace="http://schemas.vismaaddo.net/services/signingservice/v2_0/messages/getsigningtemplatesresponse/SigningTemplate" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:import namespace="http://schemas.vismaaddo.net/services/signingservice/v2_0/messages/enums/TemplateDocumentTypeEnum" /> <xs:import namespace="http://schemas.vismaaddo.net/services/signingservice/v2_0/messages/enums/TemplateUsageType" /> <xs:complexType name="ArrayOfSigningTemplateMessage"> <xs:sequence> <xs:element minOccurs="0" maxOccurs="unbounded" name="SigningTemplateMessage" nillable="true" type="tns:SigningTemplateMessage" /> </xs:sequence> </xs:complexType> <xs:element name="ArrayOfSigningTemplateMessage" nillable="true" type="tns:ArrayOfSigningTemplateMessage" /> <xs:complexType name="SigningTemplateMessage"> <xs:sequence> <xs:element minOccurs="0" name="Body" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Subject" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Type" xmlns:q1="http://schemas.vismaaddo.net/services/signingservice/v2_0/messages/enums/TemplateDocumentTypeEnum" type="q1:TemplateDocumentTypeEnum" /> <xs:element minOccurs="0" name="UsageType" xmlns:q2="http://schemas.vismaaddo.net/services/signingservice/v2_0/messages/enums/TemplateUsageType" type="q2:TemplateUsageType" /> </xs:sequence> </xs:complexType> <xs:element name="SigningTemplateMessage" nillable="true" type="tns:SigningTemplateMessage" /> </xs:schema>
<xs:schema xmlns:tns="http://schemas.vismaaddo.net/services/signingservice/v2_0/messages/enums/TemplateDocumentTypeEnum" elementFormDefault="qualified" targetNamespace="http://schemas.vismaaddo.net/services/signingservice/v2_0/messages/enums/TemplateDocumentTypeEnum" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:simpleType name="TemplateDocumentTypeEnum"> <xs:restriction base="xs:string"> <xs:enumeration value="PdfDocument" /> <xs:enumeration value="Sms" /> <xs:enumeration value="Email" /> <xs:enumeration value="SigningPortalReceipt" /> </xs:restriction> </xs:simpleType> <xs:element name="TemplateDocumentTypeEnum" nillable="true" type="tns:TemplateDocumentTypeEnum" /> </xs:schema>
<xs:schema xmlns:tns="http://schemas.vismaaddo.net/services/signingservice/v2_0/messages/enums/TemplateUsageType" elementFormDefault="qualified" targetNamespace="http://schemas.vismaaddo.net/services/signingservice/v2_0/messages/enums/TemplateUsageType" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:import namespace="http://schemas.microsoft.com/2003/10/Serialization/" /> <xs:simpleType name="TemplateUsageType"> <xs:restriction base="xs:string"> <xs:enumeration value="StartMessage" /> <xs:enumeration value="RemindMessage" /> <xs:enumeration value="Distribution"> <xs:annotation> <xs:appinfo> <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">4</EnumerationValue> </xs:appinfo> </xs:annotation> </xs:enumeration> <xs:enumeration value="CampaignStartMessage"> <xs:annotation> <xs:appinfo> <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">5</EnumerationValue> </xs:appinfo> </xs:annotation> </xs:enumeration> <xs:enumeration value="CampaignRemindMessage"> <xs:annotation> <xs:appinfo> <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">6</EnumerationValue> </xs:appinfo> </xs:annotation> </xs:enumeration> <xs:enumeration value="ApproveMessage"> <xs:annotation> <xs:appinfo> <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">7</EnumerationValue> </xs:appinfo> </xs:annotation> </xs:enumeration> <xs:enumeration value="ApproveReminderMessage"> <xs:annotation> <xs:appinfo> <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">8</EnumerationValue> </xs:appinfo> </xs:annotation> </xs:enumeration> <xs:enumeration value="SigningPortalReceiptText"> <xs:annotation> <xs:appinfo> <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">9</EnumerationValue> </xs:appinfo> </xs:annotation> </xs:enumeration> </xs:restriction> </xs:simpleType> <xs:element name="TemplateUsageType" nillable="true" type="tns:TemplateUsageType" /> </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>