Reference for http://vismaaddo.net/WebService/v2.0/RestSigningService.svc/GetSigningStatus?token={TOKEN}&signingToken={SIGNINGTOKEN}
Url: http://vismaaddo.net/WebService/v2.0/RestSigningService.svc/GetSigningStatus?token={TOKEN}&signingToken={SIGNINGTOKEN}
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:
<GetSigningStatus xmlns="http://schemas.vismaaddo.net/services/signingservice/v2_0/messages/getsigningstatus"> <AdditionalData>String content</AdditionalData> <CreatedOn>1999-05-31T11:20:00</CreatedOn> <ExpiresOn>1999-05-31T11:20:00</ExpiresOn> <ExternalReferenceId>String content</ExternalReferenceId> <Recipients> <GetSigningStatus.Recipient xmlns="http://schemas.vismaaddo.net/services/signingservice/v2_0/messages/getsigningstatus/recipient"> <AdditionalData>String content</AdditionalData> <Cpr>String content</Cpr> <Cvr>String content</Cvr> <Email>String content</Email> <ExternalId>String content</ExternalId> <FinnishSsn>String content</FinnishSsn> <IsAnonymous>true</IsAnonymous> <IsAuthenticatedOnDownload>true</IsAuthenticatedOnDownload> <Name>String content</Name> <NorwegianSsn>String content</NorwegianSsn> <PIN>String content</PIN> <SwedishSsn>String content</SwedishSsn> <Title>String content</Title> <Transactions> <GetSigningStatus.Transaction xmlns="http://schemas.vismaaddo.net/services/signingservice/v2_0/messages/getsigningstatus/transaction"> <SequenceNumber>2147483647</SequenceNumber> <State>Failed</State> <TransactionToken>1627aea5-8e0a-4371-9022-9b504344e724</TransactionToken> </GetSigningStatus.Transaction> <GetSigningStatus.Transaction xmlns="http://schemas.vismaaddo.net/services/signingservice/v2_0/messages/getsigningstatus/transaction"> <SequenceNumber>2147483647</SequenceNumber> <State>Failed</State> <TransactionToken>1627aea5-8e0a-4371-9022-9b504344e724</TransactionToken> </GetSigningStatus.Transaction> </Transactions> <VATIN>String content</VATIN> </GetSigningStatus.Recipient> <GetSigningStatus.Recipient xmlns="http://schemas.vismaaddo.net/services/signingservice/v2_0/messages/getsigningstatus/recipient"> <AdditionalData>String content</AdditionalData> <Cpr>String content</Cpr> <Cvr>String content</Cvr> <Email>String content</Email> <ExternalId>String content</ExternalId> <FinnishSsn>String content</FinnishSsn> <IsAnonymous>true</IsAnonymous> <IsAuthenticatedOnDownload>true</IsAuthenticatedOnDownload> <Name>String content</Name> <NorwegianSsn>String content</NorwegianSsn> <PIN>String content</PIN> <SwedishSsn>String content</SwedishSsn> <Title>String content</Title> <Transactions> <GetSigningStatus.Transaction xmlns="http://schemas.vismaaddo.net/services/signingservice/v2_0/messages/getsigningstatus/transaction"> <SequenceNumber>2147483647</SequenceNumber> <State>Failed</State> <TransactionToken>1627aea5-8e0a-4371-9022-9b504344e724</TransactionToken> </GetSigningStatus.Transaction> <GetSigningStatus.Transaction xmlns="http://schemas.vismaaddo.net/services/signingservice/v2_0/messages/getsigningstatus/transaction"> <SequenceNumber>2147483647</SequenceNumber> <State>Failed</State> <TransactionToken>1627aea5-8e0a-4371-9022-9b504344e724</TransactionToken> </GetSigningStatus.Transaction> </Transactions> <VATIN>String content</VATIN> </GetSigningStatus.Recipient> </Recipients> <ReferenceNumber>String content</ReferenceNumber> <SigningToken>String content</SigningToken> <State>Failed</State> <Transactions> <GetSigningStatus.Transaction xmlns="http://schemas.vismaaddo.net/services/signingservice/v2_0/messages/getsigningstatus/transaction"> <SequenceNumber>2147483647</SequenceNumber> <State>Failed</State> <TransactionToken>1627aea5-8e0a-4371-9022-9b504344e724</TransactionToken> </GetSigningStatus.Transaction> <GetSigningStatus.Transaction xmlns="http://schemas.vismaaddo.net/services/signingservice/v2_0/messages/getsigningstatus/transaction"> <SequenceNumber>2147483647</SequenceNumber> <State>Failed</State> <TransactionToken>1627aea5-8e0a-4371-9022-9b504344e724</TransactionToken> </GetSigningStatus.Transaction> </Transactions> </GetSigningStatus>
The following is an example response Json body:
{ "AdditionalData":"String content", "CreatedOn":"\/Date(928142400000+0200)\/", "ExpiresOn":"\/Date(928142400000+0200)\/", "ExternalReferenceId":"String content", "Recipients":[{ "AdditionalData":"String content", "Cpr":"String content", "Cvr":"String content", "Email":"String content", "ExternalId":"String content", "FinnishSsn":"String content", "IsAnonymous":true, "IsAuthenticatedOnDownload":true, "Name":"String content", "NorwegianSsn":"String content", "PIN":"String content", "SwedishSsn":"String content", "Title":"String content", "Transactions":[{ "SequenceNumber":2147483647, "State":0, "TransactionToken":"1627aea5-8e0a-4371-9022-9b504344e724" }], "VATIN":"String content" }], "ReferenceNumber":"String content", "SigningToken":"String content", "State":0, "Transactions":[{ "SequenceNumber":2147483647, "State":0, "TransactionToken":"1627aea5-8e0a-4371-9022-9b504344e724" }] }
The following is the response Xml Schema:
<xs:schema xmlns:tns="http://schemas.vismaaddo.net/services/signingservice/v2_0/messages/getsigningstatus" elementFormDefault="qualified" targetNamespace="http://schemas.vismaaddo.net/services/signingservice/v2_0/messages/getsigningstatus" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:import namespace="http://schemas.vismaaddo.net/services/signingservice/v2_0/messages/getsigningstatus/recipient" /> <xs:import namespace="http://schemas.vismaaddo.net/services/signingservice/v2_0/messages/enums/SigningStateEnum" /> <xs:import namespace="http://schemas.vismaaddo.net/services/signingservice/v2_0/messages/getsigningstatus/transaction" /> <xs:complexType name="GetSigningStatus"> <xs:sequence> <xs:element minOccurs="0" name="AdditionalData" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="CreatedOn" type="xs:dateTime" /> <xs:element minOccurs="0" name="ExpiresOn" type="xs:dateTime" /> <xs:element minOccurs="0" name="ExternalReferenceId" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Recipients" nillable="true" xmlns:q1="http://schemas.vismaaddo.net/services/signingservice/v2_0/messages/getsigningstatus/recipient" type="q1:ArrayOfGetSigningStatus.Recipient" /> <xs:element minOccurs="0" name="ReferenceNumber" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="SigningToken" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="State" xmlns:q2="http://schemas.vismaaddo.net/services/signingservice/v2_0/messages/enums/SigningStateEnum" type="q2:SigningStateEnum" /> <xs:element minOccurs="0" name="Transactions" nillable="true" xmlns:q3="http://schemas.vismaaddo.net/services/signingservice/v2_0/messages/getsigningstatus/transaction" type="q3:ArrayOfGetSigningStatus.Transaction" /> </xs:sequence> </xs:complexType> <xs:element name="GetSigningStatus" nillable="true" type="tns:GetSigningStatus" /> </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/getsigningstatus/recipient" elementFormDefault="qualified" targetNamespace="http://schemas.vismaaddo.net/services/signingservice/v2_0/messages/getsigningstatus/recipient" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:import namespace="http://schemas.vismaaddo.net/services/signingservice/v2_0/messages/getsigningstatus/transaction" /> <xs:complexType name="ArrayOfGetSigningStatus.Recipient"> <xs:sequence> <xs:element minOccurs="0" maxOccurs="unbounded" name="GetSigningStatus.Recipient" nillable="true" type="tns:GetSigningStatus.Recipient" /> </xs:sequence> </xs:complexType> <xs:element name="ArrayOfGetSigningStatus.Recipient" nillable="true" type="tns:ArrayOfGetSigningStatus.Recipient" /> <xs:complexType name="GetSigningStatus.Recipient"> <xs:sequence> <xs:element minOccurs="0" name="AdditionalData" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Cpr" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Cvr" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Email" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="ExternalId" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="FinnishSsn" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="IsAnonymous" type="xs:boolean" /> <xs:element minOccurs="0" name="IsAuthenticatedOnDownload" type="xs:boolean" /> <xs:element minOccurs="0" name="Name" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="NorwegianSsn" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="PIN" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="SwedishSsn" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Title" nillable="true" type="xs:string" /> <xs:element minOccurs="0" name="Transactions" nillable="true" xmlns:q1="http://schemas.vismaaddo.net/services/signingservice/v2_0/messages/getsigningstatus/transaction" type="q1:ArrayOfGetSigningStatus.Transaction" /> <xs:element minOccurs="0" name="VATIN" nillable="true" type="xs:string" /> </xs:sequence> </xs:complexType> <xs:element name="GetSigningStatus.Recipient" nillable="true" type="tns:GetSigningStatus.Recipient" /> </xs:schema>
<xs:schema xmlns:tns="http://schemas.vismaaddo.net/services/signingservice/v2_0/messages/getsigningstatus/transaction" xmlns:ser="http://schemas.microsoft.com/2003/10/Serialization/" elementFormDefault="qualified" targetNamespace="http://schemas.vismaaddo.net/services/signingservice/v2_0/messages/getsigningstatus/transaction" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:import namespace="http://schemas.vismaaddo.net/services/signingservice/v2_0/messages/enums/SigningStateEnum" /> <xs:import namespace="http://schemas.microsoft.com/2003/10/Serialization/" /> <xs:complexType name="ArrayOfGetSigningStatus.Transaction"> <xs:sequence> <xs:element minOccurs="0" maxOccurs="unbounded" name="GetSigningStatus.Transaction" nillable="true" type="tns:GetSigningStatus.Transaction" /> </xs:sequence> </xs:complexType> <xs:element name="ArrayOfGetSigningStatus.Transaction" nillable="true" type="tns:ArrayOfGetSigningStatus.Transaction" /> <xs:complexType name="GetSigningStatus.Transaction"> <xs:sequence> <xs:element minOccurs="0" name="SequenceNumber" nillable="true" type="xs:int" /> <xs:element minOccurs="0" name="State" xmlns:q1="http://schemas.vismaaddo.net/services/signingservice/v2_0/messages/enums/SigningStateEnum" type="q1:TransactionStateEnum" /> <xs:element minOccurs="0" name="TransactionToken" type="ser:guid" /> </xs:sequence> </xs:complexType> <xs:element name="GetSigningStatus.Transaction" nillable="true" type="tns:GetSigningStatus.Transaction" /> </xs:schema>
<xs:schema xmlns:tns="http://schemas.vismaaddo.net/services/signingservice/v2_0/messages/enums/SigningStateEnum" elementFormDefault="qualified" targetNamespace="http://schemas.vismaaddo.net/services/signingservice/v2_0/messages/enums/SigningStateEnum" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:import namespace="http://schemas.microsoft.com/2003/10/Serialization/" /> <xs:simpleType name="TransactionStateEnum"> <xs:restriction base="xs:string"> <xs:enumeration value="Failed"> <xs:annotation> <xs:appinfo> <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">-1</EnumerationValue> </xs:appinfo> </xs:annotation> </xs:enumeration> <xs:enumeration value="Created" /> <xs:enumeration value="Pending" /> <xs:enumeration value="Started" /> <xs:enumeration value="Signed" /> <xs:enumeration value="ReadyForDistribution" /> <xs:enumeration value="Completed" /> <xs:enumeration value="Expired" /> <xs:enumeration value="Canceled" /> <xs:enumeration value="DataCollecting" /> <xs:enumeration value="Rejected" /> </xs:restriction> </xs:simpleType> <xs:element name="TransactionStateEnum" nillable="true" type="tns:TransactionStateEnum" /> <xs:simpleType name="SigningStateEnum"> <xs:restriction base="xs:string"> <xs:enumeration value="Failed"> <xs:annotation> <xs:appinfo> <EnumerationValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/">-1</EnumerationValue> </xs:appinfo> </xs:annotation> </xs:enumeration> <xs:enumeration value="Created" /> <xs:enumeration value="Started" /> <xs:enumeration value="Completed" /> <xs:enumeration value="Expired" /> <xs:enumeration value="Stopped" /> <xs:enumeration value="CampaignStarted" /> <xs:enumeration value="Rejected" /> </xs:restriction> </xs:simpleType> <xs:element name="SigningStateEnum" nillable="true" type="tns:SigningStateEnum" /> </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>