Clients

Hiermee kunnen de cliënten van het kantoor worden opgehaald. Elke cliënt krijgt een door Alley-Oop gegenereerd ID. Dit ID moet worden gebruikt bij het zoeken/aanmaken van proces instanties (gekoppeld aan een cliënt). Het ID is ook nodig voor het afronden van taken door het sturen van signals. Cliënt hebben een aantal eigenschappen (identificerende gegevens). D de verplichting is dat minimaal 1 van deze eigenschappen is ingevuld. Naar een cliënt kan worden gezocht op basis van deze eigenschappen.

Een cliënt kan op inactief worden gezet. Op het moment dat een cliënt inactief is kan er geen proces meer voor worden opgestart. Als er nog lopende procesinstanties zijn voor de cliënt kan deze niet op inactief gezet worden.

Mogelijke HTTP methodes: GET, PUT, POST, DELETE

GET*

Als er geen van de optionele parameters wordt mee gegeven, worden alle cliënten van het kantoor teruggegeven. Een client kan worden gezocht door 1 van de optionele parameters op te geven. In dat geval wordt enkel de cliënt teruggegeven die aan de zoekopdracht voldoet.

*Deze call maakt gebruik van paging. Het maximaal aantal resultaten is daarmee gelimiteerd.

Header

Value

Verplicht

X-action

clients

JA

X-apiKey

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

JA

X-clientId

 

NEE

X-name

 

NEE

X-referId

 

NEE

X-rsin

 

NEE

X-bsn

 

NEE

X-vat

 

NEE

X-wage

 

NEE

X-kvk

 

NEE

 

Response

  
[{
    "clientId": "AAAc43283ae-f0e6-4cee-a80a-cffcce08425b",
    "name": "testje",
    "referId": "12",
    "rsin": "22",
    "bsn": "33",
    "vat": "44555",
    "wage": "55",
    "kvk": "66",
    "inactive": false
  },
  {
    "clientId": "BBBc43283ae-f0e6-4cee-a80a-cffcce08425b",
    "name": "Een klantnaam BV",
    "referId": "12",
    "rsin": "22",
    "bsn": "33",
    "vat": "44",
    "wage": "55",
    "kvk": "66",
    "inactive": true
  }] 

Property name

Value

Type

Uniek

ClientId

Het ID van de cliënt zo als gegenereerd door Alley-Oop.

String

JA

Name

De naam van de cliënt

String

NEE

RSIN

 

String

JA

BSN

 

String

JA

VAT

 

String

JA

Wage

 

String

JA

Kvk

 

String

JA

Inactive

Hier mee kan een cliënt op (in)actief worden gezet.

Boolean

NEE

PUT

Om de gegevens van een client te updaten, wordt er gebruik gemaakt van de PUT method. De JSON met gegevens van de client moet in de body worden meegegeven. ClientId is in dit geval verplicht.

Als response wordt de cliënt terug gegeven.

POST

Om een cliënt toe te voegen wordt er gebruik gemaakt van de POST method. De JSON met gegevens van de client moet in de body worden meegegeven. Er hoeft geen clientId te worden meegeven (als dit toch gebeurt word dit genegeerd).

Als response wordt de cliënt terug gegeven met gegenereerd clientId.

 

DELETE

Als een cliënt wordt verwijderd dan worden automatisch ook alle lopende procesinstanties afgesloten en verwijderd. Ook eventuele bestanden zullen worden verwijderd. Deze actie kan niet ongedaan gemaakt worden.

Hebt u meer vragen? Een aanvraag indienen

0 Opmerkingen

U moet u aanmelden om een opmerking te plaatsen.
Mogelijk gemaakt door Zendesk