Upload web service

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

Files can be posted one by one with content type 'multipart/form-data' en 'application/x-www-form-urlencoded'.   

To simplify the development process you can find below a couple of links with exemplary applications that can assist you with this web service method.

Web address

The web service, test application, description of fields and procedures can be found on below web address: 

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

Authentication

Accountants with portal

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

Users

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

Status response

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

• With an XML message (default method for response)
  The XML message can be read in the response of this web service. It includes the status of the upload and potential validation notifications.
• With a redirect
  With this option you can enter a web address that determines the redirection depending if the upload succeeds or fails.

  ---

Parameters

Domain

The name of the domain to where you want to submit your documents. 

UserName

The username by which you have access to your domain in Yuki. This parameter is mandatory in case a WebServiceAccessKey is not used as authentication. 

WebServiceAccessKey

The WebServiceAccessKey can be created in the domain or portal. This access code can grant the web service access on either administration or domain level. For more information about the access code, please refer to the article Web service access code (WebserviceAccessKey).   

Administration

The ID of the administration to which you want to upload the document. For more information about the Administration ID, please refer to the article Administration ID.

Folder 

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

Ordner ID Description

FolderTab

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

ProjectID

The ID of a project to which you want to link the document. Imparting this parameter makes the parameter 'ProjectCode' irrelevant. Yuki Projects has to be enabled beforehand in the contract.

ProjectCode

The code of the project to which you want to link the document. This parameter is only used if the parameter 'ProjectID' is not given. Yuki Projects has to be enabled beforehand in the contract.

File

The document that has to be submitted.

ResponseType

This parameter determines the way the web service responses to the result of the POST action. 

For XML: the result of the POST action will be overwritten in the XML format of the browser.

For Redirect: A redirect will be carried out after the POST action. 

The default value of this parameter is 'XML'. 

RedirectUrlSuccess

This parameter (string) is only mandatory in combination with ResponseType 'Redirect' and determines the URL for the redirection if the upload is completed. Therefore an extra parameter DocumentID= is added to the URL with as value the ID (GUID) of the filed document in Yuki. 

RedirectUrlFailed

This parameter (string) is only mandatory in combination with ResponseType 'Redirect' and determines the URL for the redirection if the upload is failed. Therefore an extra parameter DocumentID= is added to the URL with as value the ID (GUID) of the filed document in Yuki.