Mogelijke HTTP methodes: POST
POST
Met deze aanroep kan er automatisch een dossierstuk in AuditCase worden aangemaakt. De aanroep bevat minimaal het klantnummer en type configuratie (wordt verstrekt door Change to Comm). Op basis van de configuratie wordt het dossierstuk automatisch aangevuld met gegevens van de klant in AuditCase.
Tijdens de aanroep zal het dossierstuk in AuditCase worden aangemaakt en zal het door de AuditCase validatie heen lopen. Indien het document niet aangemaakt kan worden dan zal er een HTTP status 400 terugkomen met daarin dat het document niet succesvol kon worden aangemaakt. In de response staat vermeld wat er mis is gegaan.
URL
{apiurl}/document/dossier/create/{klantnummer}/{configuratietype}
Voorbeeld: /ac/api/document/dossier/create/C1001005/dossierstuk
|
URL deel |
Value |
|
{klantnummer} |
Klantnummer of id van klant |
|
{configuratietype} |
Door Change to Comm te verstrekken, bijvoorbeeld "dossierstuk". |
POST data (type: multipart/form-data)
| key | voorbeeld value | Optioneel | Omschrijving |
| file | Ja |
Bestand dat opgenomen wordt in het dossierstuk. Hier mogen meerdere bestanden in meegestuurd worden. |
|
| ShortDescriptionDO | "Jaarrekening 2016" | Ja | Een korte beschrijving van het dossierstuk. Dit kan ook opgenomen zijn in de configuratie van AuditCase. |
| AssignmentType | "DO_1" | Ja | Hiermee kan de dossierstructuur worden aangegeven. De 'value' wordt verstrekt door Change to Comm. Dit kan ook opgenomen zijn in de configuratie van AuditCase. |
| AssignmentYear | "2018" | Ja | Indien in de dossierstructuur een jaartal is opgenomen dan kan hiermee het jaar meegegeven worden. Indien niet meegegeven dan wordt het huidige jaar gebruikt. |
Response (voorbeeld)
{
"DocumentId": "4323C35D03983218C1257F340051D361",
"PermanentLink": "https://dev01.changetocomm.net/ac/redirect&target=document&clientkey=60CF6DB60A1F7EE7C1256D1E00305ED8&key=4323C35D03983218C1257F340051D361&modulename=DOSSIER",
"ClientKey": "ABC12345ABC"
"Created": true
}
|
Property name |
Value |
Type |
|
Created |
True/false als actie gelukt is. | Boolean |
|
DocumentId |
Directe sleutel naar het aangemaakte document |
String |
|
PermanentLink |
Permanente link naar het aangemaakte document |
String |
|
ClientKey |
Technische sleutel van de gekoppelde klant. |
String |