Page Comparison

...

Rate limiting is per client op het geheel van services, niet per API endpoint.

Uitleg veel voorkomende scenario’s

Hieronder worden een aantal scenario’s wat verder uitgelegd met voorbeelden. Let op dat de documentatie in de APIs zelf leading is, en onderstaande ter aanvulling.

Uploaden toegewezen bijlage

In CAPO werken we met toegewezen bijlagen. De toegewezen bijlage kan gezien worden als een container waar deelnemers bestanden (bijlagen) aan kunnen toevoegen.

• Een toegewezen bijlage is toegewezen aan een organisatie. Deze organisatie wordt geacht deze bijlage op te leveren

• Onder een toegewezen bijlage kunnen tot aan oplevering meerdere bestanden/bijlagen worden geupload.

• Na oplevering zijn er geen wijzigingen meer mogelijk op de toegewezen bijlage

Om via de API bijlagen (bestanden) te uploaden onder een toegewezen bijlage kunnen de volgende stappen worden gevolgd:

1. Vraag lijst bijlagen van specifiek project op
   GET /project/{projectId}/bijlageassigned
   Alternatief: alle bijlagen op naam van jezelf opvragen via GET /bijlageassigned

2. Vind juiste bijlageAssignedId. Bijv  "bijlageAssignedId": "62c7d159eb277e1b79161430"

3. Maak een URL voor de bijlage die je wil uploaden 
   POST ​/project​/{projectId}​/bijlageassigned​/{bijlageAssignedId}​/bijlage

4. Gebruik de teruggegeven URL direct om het bestand te uploaden

5. Geef aan dat het bestand is geupload
   PATCH /project/{projectId}/bijlage/{bijlageId} with content { "status": "uploaded" }

6. Als het het laatste bestand is voor deze bijlageAssigned; opleveren
   PATCH /project/{projectId}/bijlageassigned/{bijlageAssignedId} with content { "status": "done" }

Let op:

{bijlageAssignedId}  = ID van toegewezen bijlage
{bijlageId}              = ID van specifiek bestand

Beoordelen toegewezen bijlage

Sommige bijlagen dienen beoordeeld te worden voordat ze opgeleverd worden. Welke dit zijn is per combi gebied vooraf instelbaar door de beheerder van het project.

Een toegewezen bijlage die beoordeeld moet worden volgt stap 1 t/m 5 van bovenstaand overzicht. Echter in plaats van direct opleveren (naar status done) gaat deze bijlage naar status review. Nadat de toegewezen bijlage is beoordeeld gaat deze bij goedkeur naar status done, na afkeur terug naar status uploaded (met verplicht een reden in veld reden) waarna het proces opnieuw begint.

Zie ook de uitleg van de statussen in de API’s onder PATCH '/project/{projectId}/bijlageassigned/{bijlageAssignedId} https://services.dsplatform.nl/api/capo/documentation/#/project%20type%20Hoofdleiding/patch_project__projectId__bijlageassigned__bijlageAssignedId_

...

Samenvattend;

• de volgorde van statussen in de happy flow:
  assigned → uploaded → review → done

• Bij één afkeur in het proces is de volgorde:
  assigned → uploaded → review → uploaded → review → done