EService Web Service

EService

Click here for a complete list of operations.

DeleteDocument

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

Parameter	Value
username:
pwdHash:
itemId:
guid:
externalId:
permanently:

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /amphorapro/eservice.asmx HTTP/1.1
Host: test.amphora.ee
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.amphora.ee/DeleteDocument"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <DeleteDocument xmlns="http://www.amphora.ee">
      <username>string</username>
      <pwdHash>string</pwdHash>
      <itemId>int</itemId>
      <guid>string</guid>
      <externalId>string</externalId>
      <permanently>string</permanently>
    </DeleteDocument>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <DeleteDocumentResponse xmlns="http://www.amphora.ee">
      <DeleteDocumentResult>
        <Id>int</Id>
        <Guid>string</Guid>
        <Result>string</Result>
        <Message>string</Message>
        <ErrorCode>string</ErrorCode>
        <Error>string</Error>
        <FormId>string</FormId>
        <FormName>string</FormName>
        <RegNumber>string</RegNumber>
        <inputForm>
          <locale>string</locale>
          <title>string</title>
          <reciever>string</reciever>
          <sendTime>string</sendTime>
          <formFields>
            <xsd:schema>schema</xsd:schema>xml</formFields>
          <contactInfo>
            <senderPerson xsi:nil="true" />
            <senderOrganization xsi:nil="true" />
          </contactInfo>
          <Files>
            <File xsi:nil="true" />
            <File xsi:nil="true" />
          </Files>
        </inputForm>
        <AnswerDate>string</AnswerDate>
        <AnswerDeadline>string</AnswerDeadline>
        <ResponsibleParty>string</ResponsibleParty>
        <File>
          <id>string</id>
          <txtCaption>string</txtCaption>
          <txtDocAbstract>string</txtDocAbstract>
          <dateInput>string</dateInput>
          <txtDocType>string</txtDocType>
          <txtDocLang>string</txtDocLang>
        </File>
        <ProcessId>int</ProcessId>
        <FileObject>
          <Id>string</Id>
          <guid>string</guid>
          <Name>string</Name>
          <Alias>string</Alias>
          <Description>string</Description>
          <CreationTime>string</CreationTime>
          <MimeType>string</MimeType>
          <Crc>string</Crc>
          <Size>long</Size>
          <Compression>string</Compression>
          <ContentBase64>string</ContentBase64>
        </FileObject>
        <Form>
          <locale>string</locale>
          <title>string</title>
          <receiver>string</receiver>
          <sendTime>string</sendTime>
          <fields>
            <label>string</label>
            <localizedlabel>string</localizedlabel>
            <type>string</type>
            <value>string</value>
            <field xsi:nil="true" />
            <field xsi:nil="true" />
          </fields>
          <fields>
            <label>string</label>
            <localizedlabel>string</localizedlabel>
            <type>string</type>
            <value>string</value>
            <field xsi:nil="true" />
            <field xsi:nil="true" />
          </fields>
        </Form>
        <Url>string</Url>
        <UrlPublic>string</UrlPublic>
        <Source>string</Source>
        <CaseId>string</CaseId>
      </DeleteDocumentResult>
    </DeleteDocumentResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /amphorapro/eservice.asmx HTTP/1.1
Host: test.amphora.ee
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <DeleteDocument xmlns="http://www.amphora.ee">
      <username>string</username>
      <pwdHash>string</pwdHash>
      <itemId>int</itemId>
      <guid>string</guid>
      <externalId>string</externalId>
      <permanently>string</permanently>
    </DeleteDocument>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <DeleteDocumentResponse xmlns="http://www.amphora.ee">
      <DeleteDocumentResult>
        <Id>int</Id>
        <Guid>string</Guid>
        <Result>string</Result>
        <Message>string</Message>
        <ErrorCode>string</ErrorCode>
        <Error>string</Error>
        <FormId>string</FormId>
        <FormName>string</FormName>
        <RegNumber>string</RegNumber>
        <inputForm>
          <locale>string</locale>
          <title>string</title>
          <reciever>string</reciever>
          <sendTime>string</sendTime>
          <formFields>
            <xsd:schema>schema</xsd:schema>xml</formFields>
          <contactInfo>
            <senderPerson xsi:nil="true" />
            <senderOrganization xsi:nil="true" />
          </contactInfo>
          <Files>
            <File xsi:nil="true" />
            <File xsi:nil="true" />
          </Files>
        </inputForm>
        <AnswerDate>string</AnswerDate>
        <AnswerDeadline>string</AnswerDeadline>
        <ResponsibleParty>string</ResponsibleParty>
        <File>
          <id>string</id>
          <txtCaption>string</txtCaption>
          <txtDocAbstract>string</txtDocAbstract>
          <dateInput>string</dateInput>
          <txtDocType>string</txtDocType>
          <txtDocLang>string</txtDocLang>
        </File>
        <ProcessId>int</ProcessId>
        <FileObject>
          <Id>string</Id>
          <guid>string</guid>
          <Name>string</Name>
          <Alias>string</Alias>
          <Description>string</Description>
          <CreationTime>string</CreationTime>
          <MimeType>string</MimeType>
          <Crc>string</Crc>
          <Size>long</Size>
          <Compression>string</Compression>
          <ContentBase64>string</ContentBase64>
        </FileObject>
        <Form>
          <locale>string</locale>
          <title>string</title>
          <receiver>string</receiver>
          <sendTime>string</sendTime>
          <fields>
            <label>string</label>
            <localizedlabel>string</localizedlabel>
            <type>string</type>
            <value>string</value>
            <field xsi:nil="true" />
            <field xsi:nil="true" />
          </fields>
          <fields>
            <label>string</label>
            <localizedlabel>string</localizedlabel>
            <type>string</type>
            <value>string</value>
            <field xsi:nil="true" />
            <field xsi:nil="true" />
          </fields>
        </Form>
        <Url>string</Url>
        <UrlPublic>string</UrlPublic>
        <Source>string</Source>
        <CaseId>string</CaseId>
      </DeleteDocumentResult>
    </DeleteDocumentResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /amphorapro/eservice.asmx/DeleteDocument?username=string&pwdHash=string&itemId=string&guid=string&externalId=string&permanently=string HTTP/1.1
Host: test.amphora.ee

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<AmphoraResponse xmlns="http://www.amphora.ee">
  <Id>int</Id>
  <Guid>string</Guid>
  <Result>string</Result>
  <Message>string</Message>
  <ErrorCode>string</ErrorCode>
  <Error>string</Error>
  <FormId>string</FormId>
  <FormName>string</FormName>
  <RegNumber>string</RegNumber>
  <inputForm>
    <locale>string</locale>
    <title>string</title>
    <reciever>string</reciever>
    <sendTime>string</sendTime>
    <formFields>
      <schema xmlns="http://www.w3.org/2001/XMLSchema">schema</schema>xml</formFields>
    <contactInfo>
      <senderPerson>
        <firstName>string</firstName>
        <lastName>string</lastName>
        <personalCode>string</personalCode>
        <email>string</email>
        <phone>string</phone>
      </senderPerson>
      <senderOrganization>
        <orgName>string</orgName>
        <orgCode>string</orgCode>
        <orgEmail>string</orgEmail>
        <orgAddress>string</orgAddress>
      </senderOrganization>
    </contactInfo>
    <Files>
      <File>
        <id>string</id>
        <txtCaption>string</txtCaption>
        <txtDocAbstract>string</txtDocAbstract>
        <dateInput>string</dateInput>
        <txtDocType>string</txtDocType>
        <txtDocLang>string</txtDocLang>
      </File>
      <File>
        <id>string</id>
        <txtCaption>string</txtCaption>
        <txtDocAbstract>string</txtDocAbstract>
        <dateInput>string</dateInput>
        <txtDocType>string</txtDocType>
        <txtDocLang>string</txtDocLang>
      </File>
    </Files>
  </inputForm>
  <AnswerDate>string</AnswerDate>
  <AnswerDeadline>string</AnswerDeadline>
  <ResponsibleParty>string</ResponsibleParty>
  <File>
    <id>string</id>
    <txtCaption>string</txtCaption>
    <txtDocAbstract>string</txtDocAbstract>
    <dateInput>string</dateInput>
    <txtDocType>string</txtDocType>
    <txtDocLang>string</txtDocLang>
  </File>
  <ProcessId>int</ProcessId>
  <FileObject>
    <Id>string</Id>
    <guid>string</guid>
    <Name>string</Name>
    <Alias>string</Alias>
    <Description>string</Description>
    <CreationTime>string</CreationTime>
    <MimeType>string</MimeType>
    <Crc>string</Crc>
    <Size>long</Size>
    <Compression>string</Compression>
    <ContentBase64>string</ContentBase64>
  </FileObject>
  <Form>
    <locale>string</locale>
    <title>string</title>
    <receiver>string</receiver>
    <sendTime>string</sendTime>
    <fields>
      <label>string</label>
      <localizedlabel>string</localizedlabel>
      <type>string</type>
      <value>string</value>
      <field>
        <label>string</label>
        <localizedlabel>string</localizedlabel>
        <type>string</type>
        <value>string</value>
      </field>
      <field>
        <label>string</label>
        <localizedlabel>string</localizedlabel>
        <type>string</type>
        <value>string</value>
      </field>
    </fields>
    <fields>
      <label>string</label>
      <localizedlabel>string</localizedlabel>
      <type>string</type>
      <value>string</value>
      <field>
        <label>string</label>
        <localizedlabel>string</localizedlabel>
        <type>string</type>
        <value>string</value>
      </field>
      <field>
        <label>string</label>
        <localizedlabel>string</localizedlabel>
        <type>string</type>
        <value>string</value>
      </field>
    </fields>
  </Form>
  <Url>string</Url>
  <UrlPublic>string</UrlPublic>
  <Source>string</Source>
  <CaseId>string</CaseId>
</AmphoraResponse>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /amphorapro/eservice.asmx/DeleteDocument HTTP/1.1
Host: test.amphora.ee
Content-Type: application/x-www-form-urlencoded
Content-Length: length

username=string&pwdHash=string&itemId=string&guid=string&externalId=string&permanently=string

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<AmphoraResponse xmlns="http://www.amphora.ee">
  <Id>int</Id>
  <Guid>string</Guid>
  <Result>string</Result>
  <Message>string</Message>
  <ErrorCode>string</ErrorCode>
  <Error>string</Error>
  <FormId>string</FormId>
  <FormName>string</FormName>
  <RegNumber>string</RegNumber>
  <inputForm>
    <locale>string</locale>
    <title>string</title>
    <reciever>string</reciever>
    <sendTime>string</sendTime>
    <formFields>
      <schema xmlns="http://www.w3.org/2001/XMLSchema">schema</schema>xml</formFields>
    <contactInfo>
      <senderPerson>
        <firstName>string</firstName>
        <lastName>string</lastName>
        <personalCode>string</personalCode>
        <email>string</email>
        <phone>string</phone>
      </senderPerson>
      <senderOrganization>
        <orgName>string</orgName>
        <orgCode>string</orgCode>
        <orgEmail>string</orgEmail>
        <orgAddress>string</orgAddress>
      </senderOrganization>
    </contactInfo>
    <Files>
      <File>
        <id>string</id>
        <txtCaption>string</txtCaption>
        <txtDocAbstract>string</txtDocAbstract>
        <dateInput>string</dateInput>
        <txtDocType>string</txtDocType>
        <txtDocLang>string</txtDocLang>
      </File>
      <File>
        <id>string</id>
        <txtCaption>string</txtCaption>
        <txtDocAbstract>string</txtDocAbstract>
        <dateInput>string</dateInput>
        <txtDocType>string</txtDocType>
        <txtDocLang>string</txtDocLang>
      </File>
    </Files>
  </inputForm>
  <AnswerDate>string</AnswerDate>
  <AnswerDeadline>string</AnswerDeadline>
  <ResponsibleParty>string</ResponsibleParty>
  <File>
    <id>string</id>
    <txtCaption>string</txtCaption>
    <txtDocAbstract>string</txtDocAbstract>
    <dateInput>string</dateInput>
    <txtDocType>string</txtDocType>
    <txtDocLang>string</txtDocLang>
  </File>
  <ProcessId>int</ProcessId>
  <FileObject>
    <Id>string</Id>
    <guid>string</guid>
    <Name>string</Name>
    <Alias>string</Alias>
    <Description>string</Description>
    <CreationTime>string</CreationTime>
    <MimeType>string</MimeType>
    <Crc>string</Crc>
    <Size>long</Size>
    <Compression>string</Compression>
    <ContentBase64>string</ContentBase64>
  </FileObject>
  <Form>
    <locale>string</locale>
    <title>string</title>
    <receiver>string</receiver>
    <sendTime>string</sendTime>
    <fields>
      <label>string</label>
      <localizedlabel>string</localizedlabel>
      <type>string</type>
      <value>string</value>
      <field>
        <label>string</label>
        <localizedlabel>string</localizedlabel>
        <type>string</type>
        <value>string</value>
      </field>
      <field>
        <label>string</label>
        <localizedlabel>string</localizedlabel>
        <type>string</type>
        <value>string</value>
      </field>
    </fields>
    <fields>
      <label>string</label>
      <localizedlabel>string</localizedlabel>
      <type>string</type>
      <value>string</value>
      <field>
        <label>string</label>
        <localizedlabel>string</localizedlabel>
        <type>string</type>
        <value>string</value>
      </field>
      <field>
        <label>string</label>
        <localizedlabel>string</localizedlabel>
        <type>string</type>
        <value>string</value>
      </field>
    </fields>
  </Form>
  <Url>string</Url>
  <UrlPublic>string</UrlPublic>
  <Source>string</Source>
  <CaseId>string</CaseId>
</AmphoraResponse>