Files

 

Hiermee worden bestanden uitgewisseld tussen de verschillende API consumers. Per 'Office' wordt er door Alley-Oop automatisch een eigen zogenaamde 'file repository' verzorgd. In deze database worden alle bestanden van 1 kantoor over alle lopende processen opgeslagen en kunnen daardoor worden gedeeld met alle andere API consumers.

Alley-Oop biedt hiermee de mogelijkheid om bestanden te uploaden en per lopend proces ook weer uit te vragen. Het uitvragen welke bestanden er beschikbaar zijn, is ook mogelijk.

Mogelijke HTTP methodes: GET, POST, DELETE, PUT

GET  (bestanden opvragen)

Met deze methode kunt u de beschikbare bestanden voor dit proces opvragen. U dient hiervoor dus het proces id (instanceId) op te halen en door te geven. Indien u tevens X-type meegeeft dan ontvangt u alleen bestanden met het gevraagde type. Een overzicht van alle mogelijke typen kunt u vinden onder het kopje Filetype tabel in sectie Algemeen.

Header

Value

Verplicht

X-action

files

JA

X-apiKey

71C41054-6E3E-11E4-8C1A-F7BB2492C704

JA

X-instanceId

365005

JA

X-type

KVKUITREKSEL 
Zie Filetype tabel

NEE

Response

In de array 'attachments' ziet u alle gekoppelde bijlagen die gedownload kunnen worden. In de array 'attachmentsInfo' kan er bestandsinformatie per bijlage uitgelezen worden. 

[{
"uploadId": "B73B3E4C018B895CC1257EB4003171C9",
"typeLabel": "Concept jaarrekening",
"typeId": "CONCEPT_JAARREKENING",
"clientId": "60ab1cd6-e11f-4304-8434-c1bdd5cdcae3",
"clientName": "Eetcafé Hapjes",
"apiName": "AC-API/AO",
"processId": "365005",
"attachments": 
[        "jaarrekening_concept20.pdf"     ],
"attachementsInfo": [
{
"filename": "jaarrekening_concept20.pdf",
"filesize": 772812,
"filesizeinfo": "755kb",
"filetime": "2017-04-11 08:48:42"
} }]

GET (Bestand downloaden)

Met onderstaande methode kunt u direct een bestand downloaden. Deze call API call geeft geen JSON terug maar een binair bestand. X-uploadId is 'uploadId' in de call hierboven.

Header

Value

Verplicht

X-action

files

JA

X-apiKey

71C41004-6E3E-11E4-8C1A-F7BB2492C704

JA

X-uploadId

B73B3E4C018B895CC1257EB4003171C9

JA

X-filename

jaarrekening_concept20.pdf

JA

 

POST (Bestand uploaden naar Alley-Oop)

Header

Value

Verplicht

X-action

files

JA

X-apiKey

71C41004-6E3E-11E4-8C1A-F7BB2492C704

JA

X-instanceId

365005

JA

X-type

KVKUITREKSEL

JA

Vervolgens dient u samen met bovengenoemde headers het bestand mee te sturen met de POST parameters (Content-Disposition: form-data). Het mee te sturen bestand specificeert u door name 'file' te gebruiken (anders wordt dit niet herkend door de API).

Response

{
"uploadId": "B1E1F92DAE5A4161C1257EB40047215F",
"typeLabel": "KvK uitreksel",
"typeId": "KVKUITREKSEL",
"clientId": "e4ac528b-d7f7-454a-813f-25bee90010af",
"clientName": "Quicker",
"apiName": "AC-API/AO",
"processId": "365005",
"attachments": [
           "branche.jpg"
    ]
}

DELETE (Bestand verwijderen uit Alley-Oop)

Met deze aanroep is het mogelijk om een bestand uit Alley-Oop te verwijderen. Het vereist een 'uploadid' en een 'filename'. Beide gegevens kunnen worden opgevraagd in de GET aanroep.

 

Header

Value

Verplicht

X-action

files

JA

X-apiKey

71C41004-6E3E-11E4-8C1A-F7BB2492C704

JA

X-uploadId

B1E1F92DAE5A4161C1257EB40047215F

JA

X-filename

branche.jpg

JA

 

Response

In de response komt niets terug. Indien de operatie niet gelukt is (bestandsnaam bestaat niet of uploadid niet correct) dan komt er altijd een foutmelding.

{}

PUT (Bestand vervangen en toevoegen in bestaande upload)

Met deze aanroep is het mogelijk om een bestand toe te voegen of te vervangen aan een bestaande upload. Het vereist een 'uploadid'. Dit gegeven kan worden opgevraagd in de GET aanroep. Als u een bestand wilt vervangen dan kunt u een nieuw bestand met dezelfde bestandsnaam meesturen. 

 

Header

Value

Verplicht

X-action

files

JA

X-apiKey

71C41004-6E3E-11E4-8C1A-F7BB2492C704

JA

X-uploadId

B1E1F92DAE5A4161C1257EB40047215F

JA

Vervolgens dient u samen met bovengenoemde headers het bestand mee te sturen met de POST parameters (Content-Disposition: form-data). Het mee te sturen bestand specificeert u door name 'file' te gebruiken (anders wordt dit niet herkend door de API).

Response

 

[{
"uploadId": "B73B3E4C018B895CC1257EB4003171C9",
"typeLabel": "Concept jaarrekening",
"typeId": "CONCEPT_JAARREKENING",
"clientId": "60ab1cd6-e11f-4304-8434-c1bdd5cdcae3",
"clientName": "Eetcafé Hapjes",
"apiName": "AC-API/AO",
"processId": "365005",
"attachments": 
[        "jaarrekening_concept20.pdf",
"jaarrekening_definitief.pdf"     ],
"attachementsInfo": [
{
"filename": "jaarrekening_concept20.pdf",
"filesize": 772812,
"filesizeinfo": "755kb",
"filetime": "2017-04-11 08:48:42"
},{
"filename": "jaarrekening_definitief.pdf",
"filesize": 172812,
"filesizeinfo": "655kb",
"filetime": "2017-04-12 10:38:12"
} }]
Hebt u meer vragen? Een aanvraag indienen

0 Opmerkingen

Artikel is gesloten voor opmerkingen.
Mogelijk gemaakt door Zendesk