Upload web service

This web service enables you to upload files directly from your own application to your administration in Yuki. This web service runs via HTTP POST.

Files can be posted one by one with contenttype 'multipart/form-data' and 'application/x-www-form-urlencoded'.

In order to simplify the development process you will find two links to example applications with which you can call this web services method at the bottom of this article. 

TIP!

Instead of using the Upload web service, you can also use the Archive web service. The Archive web service has the advantage to send two files at ones, for example the PDF and UBL XML.

Web address

You will find the web service, a test application, a description of the fields and the procedures at the web address below:

https://api.yukiworks.nl/docs/Upload.aspx

Authentication

Accountants with portal

Accountants with a portal authenticate by means of the WebserviceAccessKey. This can be created in the portal.

Users

Users authenticate by means of the WebserviceAccessKey or with a username and password.

Status response

This web service offers two options to return the result of the POST action:

• With a XML message (default mode of feedback)
  The XML message can be read out in the response of this web service. It contains the upload status and the possible validation notifications.
• Via a redirect
  With this option you can give a web address that determines to where redirection will be executed if the upload has failed or is successful.

Parameters

Domain

The name of the domain in which you want to submit the documents.

UserName

The username which provides access to your domain in Yuki. This parameter is required if the WebServiceAccessKey is not used for authentication.

WebServiceAccessKey

The WebServiceAccessKey can be created in the domain or the portal. This access code can give web service access on administration level or on domain level. For a detailed description of the creation of the access code see articles 'Set web services in portal' and 'Set web services in domain and/or administration'.

Administration

The ID of the administration to which you want to upload the document. For a detailed description of the retrieval of the Administration ID see article Administration ID.

Folder

The folder in which you want to save the document. The default value of this parameter is '7' ('To be handled by Yuki' folder). Possible options are:

Folder ID Description

FolderTab

The tab of the folder in which you want to save the document. The default value of this parameter is blank.

ProjectID

The ID of the project to which you want to link the document. Giving this parameter makes the 'ProjectCode' parameter unnecessary. The Yuki Dossiers module must have been activated in the contract.

ProjectCode

The code of the project to which you want to link the document. This parameter is only used when the 'ProjectID' parameter is not given. The Yuki Dossiers module must have been activated in the contract.

File

The document to be submitted.

ResponseType

This parameter determines the way in which the web service returns the result of the POST action. If ii is 'XML' then the result of the POST action will be saved in the browser in XML format. If it is 'Redirect' then a redirection will be executed after the POST action. The default value of this parameter is 'XML'.

RedirectUrlSuccess

This parameter (string) is only required in combination with ReponseType 'Redirect' and determines the URL to where redirection will be executed if the upload is successful. An additional parameter 'DocumentID=' that has as value the ID (GUID) of the document saved in Yuki will be added to this URL.

RedirectUrlFailed

This parameter is only required in combination with ReponseType 'Redirect' and determines the URL to where redirection will be executed if the upload has failed. An additional parameter 'DocumentID=' that has the value the ID (GUID) of the document saved in Yuki wil be added to this URL.

Examples

• Example of application written in PHP
• Example of application written in HTML