Upload Webservice


Raadpleeg onze online help voor meer informatie over onze WebServices.

Upload

Geeft een administratie ID op basis van de naam van een administratie

Test

Klik op de knop Aanroepen om de bewerking te testen met het HTTP POST-protocol.
Parameter Waarde Omschrijving
Domain:
De naam (string) van het domein waar je documenten in wilt aanleveren.
UserName:
De gebruikersnaam (string) waarmee je toegang hebt tot je domein in Yuki. Deze parameter is verplicht indien er niet met een WebServiceAccessKey wordt geauthenticeerd.
Password:
Het wachtwoord (string) die bij je gebruikersnaam hoort. Deze parameter is verplicht indien er niet met een WebServiceAccessKey wordt geauthenticeerd.
WebServiceAccessKey:
De WebServiceAccessKey GUID (string) kan in het domein of via de accountantsportal worden aangemaakt. Deze sleutel kan webservicetoegang verlenen op administratie- of domeinniveau. Instructies voor het aanmaken van deze sleutel staan in onze wiki.
Administration:
De administratie GUID (string) waar je het document in wilt opslaan.
Folder:
De ordner (integer) waarin je het document wilt opslaan. De defaultwaarde van deze parameter is "7".
FolderTab:
De ordnertab (integer) waarin je het document wilt opslaan. De defaultwaarde van deze parameter is leeg.
ProjectID:
De HID van het dossier waaraan je het document wilt koppelen. Het meegeven van deze parameter maakt de parameter "ProjectCode" overbodig. De optie voor dossiers dient wel te zijn geactiveerd in het contract.
ProjectCode:
De code van het dossier waaraan je het document wilt koppelen. Deze parameter wordt alleen gebruikt als de parameter "ProjectID" niet wordt meegegeven. De optie voor dossiers dient wel te zijn geactiveerd in het contract.
File: Het aan te leveren document.

ResponseType:
Deze parameter (string) bepaalt de wijze waarop deze webservice het resultaat van de POST-actie teruggekoppelt. Indien "XML" zal het resultaat van de POST-actie in XML-formaat in de browser weggeschreven. Indien "Redirect" wordt er na de POST-actie een redirect uitgevoerd. De defaultwaarde van deze parameter is "XML".
RedirectUrlSuccess:
Deze parameter (string) is alleen verplicht in combinatie met ReponseType "Redirect" en bepaalt de url waarheen geredirect wordt als de upload is geslaagd. Er wordt aan deze url een extra parameter toegevoegd, "DocumentID=" met als waarde de ID (GUID) van het opgeslagen document in Yuki.
RedirectUrlFailed:
Deze parameter (string) is alleen verplicht in combinatie met ReponseType "Redirect" is en bepaalt de url waarheen geredirect wordt als de upload is mislukt. Er wordt aan deze url een extra parameter toegevoegd, "DocumentID=" met als waarde de ID (GUID) van het opgeslagen document in Yuki.

HTTP POST

Hier volgt een voorbeeld van een HTTP POST-aanvraag. De weergegeven tijdelijke aanduidingen moeten worden vervangen door feitelijke waarden.

POST https://api.yukiworks.nl/docs/Upload.aspx?WebServiceAccessKey=string&UserName=string
		&Password=string&Domain=string&Administration=string&FileName=string&Folder=integer&FolderTab=integer
		&ReponseType=string&RedirectUrlSuccess=string&RedirectUrlFailed=string HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Content-Length: length

...contents of file...

HTTP POST

Hier volgt een voorbeeld van een HTTP POST-aanvraag. De weergegeven tijdelijke aanduidingen moeten worden vervangen door feitelijke waarden.

POST https://api.yukiworks.nl/docs/Upload.aspx HTTP/1.1
Content-Type: multipart/form-data; boundary=-----------------------------7dccf3410588
Content-Length: length

-----------------------------7dccf3410588
Content-Disposition: form-data; name="WebServiceAccessKey"

string
-----------------------------7dccf3410588
Content-Disposition: form-data; name="UserName"

string
-----------------------------7dccf3410588
Content-Disposition: form-data; name="Password"

string
-----------------------------7dccf3410588
Content-Disposition: form-data; name="Domain"

string
-----------------------------7dccf3410588
Content-Disposition: form-data; name="Administration"

string
-----------------------------7dccf3410588
Content-Disposition: form-data; name="FileName"

string
-----------------------------7dccf3410588
Content-Disposition: form-data; name="Folder"

integer
-----------------------------7dccf3410588
Content-Disposition: form-data; name="FolderTab"

Integer
-----------------------------7dccf3410588
Content-Disposition: form-data; name="ResponseType"

string
-----------------------------7dccf3410588
Content-Disposition: form-data; name="RedirectUrlSuccess"

string
-----------------------------7dccf3410588
Content-Disposition: form-data; name="RedirectUrlFailed"

string
-----------------------------7dccf3410588
Content-Disposition: form-data; name="fileupload1"; filename="C:\Documents\Facturen\scan_003.jpg"
Content-Type: image/pjpeg

...contents of scan_003.jpg...

HTTP POST

Hier volgt een voorbeeld van een HTTP POST-antwoord.

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

<?xml version="1.0" encoding="utf-8"?>
<UploadResponse>
	<UploadSuccess>boolean</UploadSuccess>
	<Message>string</Message>
	<DocumentID>string</DocumentID>
</UploadResponse>