Oude API
- 1 Inleiding
- 2 Voorbereiding
- 3 Protocol
- 4 Voorbeeldprogramma's
- 5 Tabellen Soorten werk en Toestanden
- 6 Beschikbare queries
- 6.1 TEST
- 6.2 DEPLOYMENTS
- 6.3 DEPLOYMENTSPECIFICATIONS
- 6.4 ROSTERS
- 6.5 ROSTER_DEFAULT_COSTCENTERS
- 6.6 RESOURCES
- 6.7 CONTRACTEDTIME
- 6.8 SHIFTS
- 6.9 SHIFTTEMPLATESPECS
- 6.10 CROSS_ROSTER_TIME
- 6.11 DEPLOYMENTS_CW
- 6.12 DEPLOYMENTS_VP
- 6.13 OPENSHIFTS
- 6.14 OPENSHIFTAPPLICATIONS
- 6.15 SALARYTOTALS
- 6.16 LEAVE_FORMS
- 6.17 UNFINISHED_LEAVE_FORMS
- 6.18 OVERTIME
- 6.19 VEHICLEASSIGNMENTS
- 6.20 VEHICLEASSIGNMENTREMARKS
- 7 ResponseStatus codes
Inleiding
Om uiteenlopende redenen kan het nodig of nuttig zijn om je gegevens uit Roosterplanning beschikbaar te hebben in andere omgevingen. Hiervoor is een API (Application Programming Interface) beschikbaar. In dit document wordt beschreven hoe deze API werkt.
Om gebruik te kunnen maken van de API moet C-quential een gebruiker met API rechten aanmaken. De aanvraag voor het gebruik van API dient via support aangevraagd te worden. Voor het configureren en toelichten van de API wordt meerwerk in rekening gebracht. Bij klanten die Reporting Plus afnemen is de API inbegrepen.
De maximale hoeveelheid data per dag die je op kunt vragen is 10 MB.
Voorbereiding
Om met de API in te kunnen loggen heb je een gebruikersaccount met API rechten nodig. Wanneer de toestemming gegeven is voor het gebruik van de API functionaliteit zal C-quential de gebruikersnaam en het wachtwoord doorgeven aan de betreffende aanvrager.
Protocol
De API maakt gebruik van het https protocol. Om de API te kunnen gebruiken zijn de volgende stappen nodig:
Inloggen
Ontvangen van sessie id
Aanvragen doen aan de API
Verwerken van antwoorden van de API
Inloggen
Om in te loggen dient een https POST request verstuurd te worden naar <https://klantid.c-quential.nl/api/
waarbij klantid je eigen klantid is. Het POST request ziet er als volgt uit:
<?xml version="1.0" encoding="UTF-8" ?>
<Login>
<Username>je_gebruikers_naam</Username>
<Password>je_wachtwoord</Password>
</Login>Waarbij je gebruikersnaam en je wachtwoord uiteraard vervangen moeten worden door je eigen gebruikersnaam en je wachtwoord.
Ontvangen van sessie id
Indien je rechten hebt om de API te gebruiken en je logingegevens zijn correct dan
stuurt de server de volgende response:
<?xml version="1.0" encoding="UTF-8" ?>
<LoginResult>
<ResponseStatus>OK</ResponseStatus>
<ResponseMessage></ResponseMessage>
<Username>uw_gebruikers_naam</Username>
<SessionId>sessie_id</SessionId>
</LoginResult>Deze sessie id is uniek voor iedere login en is van belang bij het doen van aanvragen aan de API.
Aanvragen doen aan de API
Om een aanvraag de doen aan de API wordt een https POST request verstuurd:
<?xml version="1.0" encoding="UTF-8"?>
<Query>
<SessionId>session_id</SessionId>
<Id>query_id</Id>
<Parameters>
<Parameter>
<Name>parameter_1</Name>
<Value>waarde_1</Value>
</Parameter>
<!-- overige parameters -->
</Parameters>
</Query>Hierbij is method de functie die je aanroept (in dit geval query), gevolgd door de functie parameters (in dit geval TESTQUERY)
Verwerken van antwoorden van de API
Indien een correcte aanvraag aan de API is gedaan, dan zal deze een response in XML sturen. Deze response kan verwerkt worden zoals je wilt. De response van de API ziet er als volgt uit:
Soorten velden in het antwoord
Tekst: Spreekt voor zichzelf.
Integer: Geheel getal, spreekt voor zichzelf.
DatumTijd: In formaat jjjj-mm-ddThh:mm:ss (standaard ISO 8601 formaat, tijden zijn Nederlandse tijden).
Datum: Zelfde formaat als DatumTijd, waarbij altijd 00:00:00 wordt ingevuld voor hh:mm:ss (voor input parameters is ook jjjj-mm-dd toegestaan).
Boolean: 1 (waar) of 0 (niet waar)
Voorbeeldprogramma's
Doordat de API gebruik maakt van het https protocol is het in alle moderne programmeertalen eenvoudig om er gebruik van te maken. Hieronder volgen voorbeelden hoe de API gebruikt kan worden:
Tabellen Soorten werk en Toestanden
Voor de API wordt veelvuldig gebruik gemaakt van de tabellen “Soorten werk: Type” en “Toestanden: State”. Onderstaand de tabellen met de nummers per Type en State die je ingeeft bij het uitvragen van de API:
Soorten werk (Type)
Type | Id | Opmerking |
|---|---|---|
working | 2 | Paraat |
reachable | 4 | Bereikbaar |
working_no_ort | 5 | Paraat geen ORT |
present_new | 6 | Aanwezig |
working_no_hrs | 7 | Paraat geen tijdtelling |
present_new2 | 8 | Aanwezig 2, gedraagt zich als Aanwezig |
shifted_work_normal | 9 | Verschoven dienst op gewone dag, gedraagt zich als working |
shifted_work_free_day | 10 | Verschoven dienst op vrije dag, gedraagt zich als working |
waiting | 11 | Wachturen brandweer, gedraagt zich als present_new |
sleeping | 12 | Slaapuren brandweer, gedraagt zich als present_new |
reachable2 | 13 | Bereikbaar 2, gedraagt zich als bereikbaar |
working2 | 14 | Paraat 2, gedraagt zich als working maar in de db (roTypeContractFractions) kun je ook een andere urenfactor instellen |
working3 | 15 | Paraat 3, gedraagt zich als working maar kun in de db (roTypeContractFractions) kun je ook een andere urenfactor instellen) |
reachable_no_overtime | 16 | Bereikbaar geen overwerk, gedraagt zich als bereikbaar met uitzondering van het indienen van overwerk dat niet mogelijk is gedurende deze uren |
Toestanden (State)
State | Value | Opmerking |
|---|---|---|
normal | 1 | Normaal |
free | 2 | Verlof |
sick | 3 | Ziek |
extra | 4 | Extra dienst |
special_leave | 5 | Bijzonder verlof |
waitday | 6 | Wachtdag |
unpaid_leave | 7 | Onbetaald verlof |
partime_leave | 8 | Niet gebruiken |
comp_leave | 9 | Compensatie/feestdagenverlof |
training | 10 | Inwerk |
leave2 | 11 | PLB verlof |
extra2 | 12 | Deze werkt exact hetzelfde als 'extra' maar geeft de mogelijkheid om 2 verschillende soorten extra dienst te configureren voor 1 contract. |
care_leave | 13 | Kopie van 'free'. Niet gebruiken! |
special_leave2 | 14 | Kopie van Bijzonder verlof |
leave_during_sickness | 15 | Verlof tijdens ziekte (wordt gebruikt voor medewerkers wiens contracturen op 0 staan ivm langdurig ziek) |
Beschikbare queries
TEST
Inhoud
Dit is een testquery, die geen parameters vereist. Deze stuurt twee records met vaste waarden terug.
Velden in response
Id: 2354 en 3646 (Integer)
Username: jjansen en kdevries (Tekst)
DEPLOYMENTS
Inhoud
Iedere record correspondeert met een inzet van een dienst op een medewerker in een rooster.
Parameters
beginDate (verplicht, begindatum van deployments)
endDate (verplicht, einddatum van deployments)
Maximale periode
100 dagen
Velden in response
DeploymentId | Id van de record (Integer) |
|---|---|
ShiftId | verwijzing naar SHIFTS (Integer) |
ResourceId | verwijzing naar RESOURCES (Integer) Als deze 0 is, dan betreft het een inzet van een Uitzendbureau (dus geen medewerker). |
Timestamp | datum laatste wijziging (DatumTijd) |
DeplDate | datum van inzet (Datum) |
State | toestand waarin de dienst ingezet is. |
IsSpecified | of de inzet afwijkend is (Boolean). Als dit niet afwijkend is, dan volgen de DeploymentSpecifications de ShiftTemplateSpecifications. |
|
|
Inhoud
Bij iedere deployment (inzet) hoort werktijd (of bereikbare tijd, of aanwezige tijd). Welke tijden dat zijn en van hoe laat tot hoe laat wordt middels deze query doorgegeven.
Parameters
beginDate (verplicht, begindatum van deployments)
endDate (verplicht, einddatum van deployments)
Maximale periode
100 dagen
Velden in response
DeploymentSpecificationId | Id van de record (Integer) |
DeploymentId | verwijzing naar DEPLOYMENTS (Integer) |
TimeBegin | aanvangsttijd genoteerd in aantal seconden sinds 00:00 (Integer) |
TimeEnd | eindtijd genoteerd in aantal seconden sinds 00:00 (Integer) |
Type | het soort werktijd (Integer). Voor verdere toelichting zie “Tabellen soorten werk en Toestanden”. |
State | toestand waarin deze specifieke werktijd ingezet is (Integer). Deze toestand kan afwijken van de toestand waarmee bijbehorende DEPLOYMENT ingezet is. Voor verdere toelichting zie “Tabellen soorten werk en Toestanden”. |
Project | Indien gebruik wordt gemaakt van Projecten en Activiteiten functionaliteit, wordt het Project behorende bij deze DeploymentSpecification meegestuurd (text) |
ProjectGrouping | Indien gebruik wordt gemaakt van Projecten en Activiteiten functionaliteit, wordt de Groupering behorende bij de Activiteit voor bij deze DeploymentSpecification meegestuurd (text) |
Activity | Indien gebruik wordt gemaakt van Projecten en Activiteiten functionaliteit, wordt de Activiteit behorende bij deze DeploymentSpecification meegestuurd (text) |
ActivityGrouping | Indien gebruik wordt gemaakt van Projecten en Activiteiten functionaliteit, wordt de Groupering behorende bij de Activiteit voor bij deze DeploymentSpecification meegestuurd (text) |
Inhoud
Geeft een overzicht van alle roosters met bijbehorende gegevens.
Velden in response
RosterId | Id van de record (Integer) |
Name | naam van het rooster (Tekst) |
Location | naam van de locatie van het rooster (Tekst) |
Organisation | organisatie waartoe het rooster behoort (Tekst) |
StartDate | datum waarop het rooster begonnen is (Datum) |
ProposedUntil | datum tot wanneer het rooster voorgesteld is (Datum) |
PublishedUntil | datum tot wanneer het rooster gepubliceerd is (Datum) |
Inhoud
Geeft een overzicht van de standaard kostenplaatsen per rooster (per datum). Deze query is alleen bruikbaar voor HR-Core gekoppelde klanten.
Velden in response
RosterId | Id van de record (Integer) |
BeginDate | datum waarop deze kostenplaats geldt voor het rooster (Datum) |
CostCenter | Kostenplaats |
Inhoud
Geeft een overzicht van alle medewerkers en bijbehorende gegevens.
Velden in response
ResourceId | Id van de record (Integer) |
Username | gebruikersnaam van de medewerker waarmee hij/zij inlogt (Tekst) |
CostCenter | naam van de medewerker (Tekst) |
StaffNo | personeelsnummer van de medewerker (Tekst) |
BeginDate | datum in dienst (Datum) |
EndDate | datum uit dienst (Datum) |
RitAdminCode | MKA nummer (ritdata module) |
Inhoud
Ieder record correspondeert met een nieuw ingegaan contract voor een medewerker.
Velden in response
ContractedTimeId | Id van de record (Integer) |
ResourceId | verwijzing naar RESOURCES (Integer): voor welke medewerker dit contract is |
BeginDate | ingangsdatum van het contract (Datum) |
EndDate | einddatum van het contract (Datum) |
TimePerWeek | te werken tijd per week genoteerd in aantal seconden (Integer) |
TimePregnant | zwangersverlof tijd per week in seconden (Integer) |
TimeSick | langdurige ziekte per week in seconden (Integer) |
TimeParentalLeave | ouderschapsverlof per week in seconden (Integer) |
TimeOther | andersoortige tijd in seconden (Integer) |
Contract | naam van het contract dat van toepassing is |
Organisation | organisatie waartoe de medewerker binnen dit contract behoort (Tekst) |
RosterId | verwijzing naar ROSTERS (Integer). Deze geeft aan tot welk rooster de medewerker binnen dit contract behoort |
Position | plaats waar de medewerker binnen dit contract in het rooster staat (Integer) |
CostCenter | Kostenplaats (HR-Core specifiek) |
Inhoud
Dit geeft een overzicht van welke dienstcodes (ShiftTemplates) in welk rooster (Rosters) ingezet kunnen worden.
Velden in response
ShiftId | Id van de record (Integer) |
RosterId | verwijzing naar ROSTERS om aan te geven welk rooster (Integer) |
ShiftTemplateId | verwijzing naar SHIFTTEMPLATES om aan te geven welke dienstcode (Integer) |
Inhoud
Bij iedere ShiftTemplate (dienstcode) hoort werktijd (of bereikbare tijd, of aanwezige tijd). Welke tijden dat zijn en van hoe laat tot hoe laat wordt middels deze query doorgegeven.
Velden in response
ShiftTemplateSpecId | Id van de record (Integer) |
ShiftTemplateId | verwijzing naar SHIFTTEMPLATES (Integer) |
TimeBegin | aanvangsttijd genoteerd in aantal seconden sinds 00:00 (Integer) |
TimeEnd | eindtijd genoteerd in aantal seconden sinds 00:00 (Integer) |
Type | het soort werktijd (Integer) |
CostCenter | kostenplaats |
Inhoud
Iedere record representeert de tijd die door een medewerker in een afdeling gewerkt is in een maand. De export kan voor de hele organisatie opgevraagd worden voor een specifieke maand en jaar.
Parameters
year (verplicht, het opgevraagde jaar, bijv. '2011')
month (verplicht, de opgevraagde maand als getal, bijv. '4' voor april)
Velden in response
Year | het opgevraagde jaar |
Month | de opgevraagde maand |
Staffno | opgebouwd uit DBS medewerker nr en contract nr. |
ResourceId | intern RoosterWeb id van de medewerker (wordt niet gebruikt door Omring) |
RosterIdFrom | het id van het rooster waar de medewerker in zit (Orion vertaalt vervolgens dit Id naar de oe code) |
RosterIdTo | het id van het rooster waar de medewerker ingezet wordt (ook hier vertaal Orion vervolgens dit Id naar de oe code) |
Time | het aantal uren dat de medewerker ingezet is (in seconden). |
State | de toestand waarin de medewerker ingezet is. Voor verdere toelichting zie “Tabellen soorten werk en Toestanden” |
Inhoud
Deze query stuurt de codes van inzetten terug met bijbehorende tijdsperiodes. Deze query is heel specifiek ingericht voor de koppeling met Careware van MCH+. Iedere record correspondeert met een aaneengesloten stuk werktijd voor één medewerker.
Parameters
beginDate (verplicht, begindatum van deployments)
endDate (verplicht, einddatum van deployments)
organisation (optioneel, organisatie waarvoor deployments opgehaald moeten worden)
Maximale periode
100 dagen
Velden in response
Code | Dienstcode horende bij de ingezette tijd (Tekst) |
|---|---|
Personeelsno | Personeelsnummer van de medewerker (Tekst) |
Date | Datum van de inzet (Datum) |
Remark | Eventuele opmerking (Tekst) |
From | Aanvangsttijdstip (DatumTijd) |
To | Eindtijdstip (DatumTijd) |
Inhoud
Deze query stuurt de codes van inzetten terug met bijbehorende tijdsperiodes. Deze query is heel specifiek ingericht voor de koppeling met Veiligheidspaspoort van Magenta. Iedere record correspondeert met een aaneengesloten stuk werktijd voor één medewerker. Er worden alleen gepubliceerde inzetten teruggestuurd.
Parameters
beginDate (Datum, verplicht (tenzij beginDateTime wordt gebruikt), deployments worden opgehaald vanaf beginDate)
endDate (Datum, verplicht (tenzij endDateTime wordt gebruikt), deployments worden opgehaald tot en met endDate)
organisation (Tekst, optioneel, organisatie van de medewerkers waarvoor deployments opgehaald moeten worden)
Per release 3 novembe 2021:
beginDateTime (DatumTijd (jjjj-mm-ddTuu:mm:ss), verplicht (tenzij beginDate wordt gebruikt) kan gebruikt worden i.p.v. beginDate. Geeft deployments vanaf de datum/tijd die overlappen met de waarde van deze parameter)
Voorbeeld: beginDateTime parameter is 2021-10-01T10:00:00, dan kun je een resultaat terugkrijgen met datum/tijd FROM 2021-10-01T08:00:00 en TO 2021-10-01T13:00:00
endDateTime (DatumTijd (jjjj-mm-ddTuu:mm:ss), verplicht (tenzij endDate wordt gebruikt) kan gebruikt worden i.p.v. endDate. Geeft deployments terug tot en met de datum/tijd die overlappen met de waarde van deze parameter).
Verplichte parameters zijn OF beginDate en endDate, OF beginDateTime en endDateTime. Bij een combinatie genereert deze query een foutmelding.
Maximale periode
100 dagen
Velden in response
Code | Dienstcode horende bij de ingezette tijd (Tekst) |
|---|---|
Staffno | Personeelsnummer van de medewerker (Tekst) |
Name | Naam van de medewerker (Tekst) |
Roster | Rooster waarin deze dienst is ingezet (Tekst) |
Date | Datum van de inzet (Datum) |
Remark | Opmerking bij de inzet (Tekst) |
From | Aanvangsttijdstip (DatumTijd) |
To | Eindtijdstip (DatumTijd) |
Type | het soort werktijd (Integer) |
IntType | 40: define('ROSTER_SHIFT_INT_TYPE_PARAAT', 40); 40 => 'Normaal met positietoewijzing' |
State | toestand waarin de dienst ingezet is (Integer). De mapping van de nummers is: 1 (Normaal), 4 (Extra dienst), 10 (Inwerk) en 12 (|Extra dienst 2) Alleen bovenstaande toestanden gaan mee in deze API call |
Inhoud
Deze query geeft alle gepubliceerde openstaande diensten voor vandaag of in de toekomst.
Parameters
Geen: Altijd alle openstaande diensten voor vandaag of in de toekomst worden gestuurd.
Velden in response
OpenShiftId | Id van de record (Integer) |
|---|---|
OpenDate | Datum waarop deze openstaande dienst gepubliceerd is (Datum) |
OpenedBy | gebruikersnaam van degene die de openstaande dienst gepubliceerd heeft (Tekst) |
State | de status van de gepubliceerde openstaande dienst (Integer). De mapping van de nummering is:
|
ShiftDate | datum van de gepubliceerde openstaande dienst (Datum) |
ShiftId | dienst die gepubliceerd is. Verwijst naar SHIFTS (Integer) |
ShiftCode | De daadwerkelijke dienstcode (Tekst) (nieuw per release mei 2022) |
Remark | eventuele opmerking bij de gepubliceerde openstaande dienst (Tekst) |
Inhoud
Deze query geeft alle aanmeldingen die gedaan zijn voor alle gepubliceerde openstaande diensten voor vandaag of in de toekomst.
Parameters
Geen. Altijd alle aanmeldingen voor openstaande diensten voor vandaag of in de toekomst worden gestuurd.
Velden in response
OpenShiftApplicationId | Id van de record (Integer) |
|---|---|
OpenShiftId | verwijzing naar OPENSHIFTS (Integer); de openstaande dienst waarvoor deze aanmelding is. |
ResourceId | verwijzing naar RESOURCES (Integer); de medewerker die zich aangemeld of afgemeld heeft. |
State | de status van de aanmelding. De mapping van de nummering is:
|
Inhoud
Iedere record correspondeert met de totalen van de urenverantwoording van een medewerker voor de opgegeven maand.
Parameters
year (verplicht, het opgevraagde jaar, bijv. '2021')
month (verplicht, de opgevraagde maand als getal, bijv. '4' voor april)
Velden in response
SalaryTotalId | Id van de record (Integer) |
|---|---|
ResourceId | verwijzing naar RESOURCES (Integer) |
StaffNo | personeelsnummer van de medewerker (Tekst) |
Name | Naam van de medewerker (Tekst) |
ContractId | ID van contract dat geldt voor medewerker op deze maand (Integer) |
ContractName | naam van contract dat geldt voor medewerker op deze maand (Tekst) |
AcceptDate | datum waarop de urenverantwoording door de leidinggevende geaccepteerd is (Datum) |
PiketType1 | hoeveelheid bereikbaarheid type 1 in seconden (Integer) |
PiketType2 | hoeveelheid bereikbaarheid type 2 in seconden (Integer) |
Inhoud
Geeft vrijetijdsaanvragen terug in alle statussen. Indien een aanvraag in status 'progress / progressdev / submitted' staat, worden datums die binnen de aanvraag, maar buiten het gepubliceerde rooster vallen, meegestuurd in een array.
Parameters
offset: begin met 0, je krijgt dan de eerste 1000 records terug. Dan nogmaals aanroepen met waarde 1000 en je krijgt de volgende 1000 terug, etc. Tot je er minder dan 1000 terugkrijgt, dan is hij klaar
Velden in response
FormId | ID van het formulier waarmee de aanvraag is ingediend (integer) |
|---|---|
ResourceId | ID van de Resource waarvoor de aanvraag geldt |
State | De status van het formulier (text) |
LeavePeriodBeginDate | Het veld 'Datum van' uit het aanvraagformulier (datum) |
LeavePeriodEndDate | Het veld 'Datum t/m' uit het aanvraagformulier (datum) |
Remark | Opmerking bij de aanvraag |
LeaveType | Het type verlof (niet de regeling!). Dit verschilt per klant. Je kunt denken aan 'Verlof', 'Bijzonder verlof', 'PLB' (text) |
datesOutsidePublishedRoster | Datums buiten het gepubliceerde rooster die binnen de aanvraag vallen (unix timestamp). Elke datum is gespecificeerd als <Item>0000000000</Item> binnen deze array. |
Inhoud
Geeft vrijetijdsaanvragen terug in de statussen 'progress / progressdev / submitted' en een array met datums buiten het gepubliceerde rooster.
Velden in response
FormId | ID van het formulier waarmee de aanvraag is ingediend (integer) |
|---|---|
ResourceId | ID van de Resource waarvoor de aanvraag geldt |
Remark | Opmerking bij de aanvraag |
datesOutsidePublishedRoster | Datums buiten het gepubliceerde rooster die binnen de aanvraag vallen (unix timestamp). Elke datum is gespecificeerd als <Item>0000000000</Item> binnen deze array. |
Inhoud
Geeft de overwerkformulieren terug.
Parameters
beginDate
endDate (het mag een periode van maximaal 31 dagen zijn)
Velden in response
FormId | ID van het formulier waarmee de aanvraag is ingediend (integer) |
|---|---|
ResourceId | ID van de Resource waarvoor de aanvraag geldt |
Date | Datum van de aanvraag (datum) |
TimeBegin | datum + tijd aanvang |
TimeEnd | datum + tijd einde |
Type | Soort overwerk (tekst) |
TypeId | intern type id (tekst) |
Reason | Reden (tekst) |
Inhoud
Een overzicht van de ambulances ingezet op een dag en met welke ambulancechauffeur en welke ambulanceverpleegkundige.
Parameters
date (verplicht, datum voor welke de ambulances en toewijzingen opgevraagd wordt)
Velden in response
AmbulanceNr | Wagennummer (Tekst) |
|---|---|
AmbulanceLicense | Kenteken (Tekst) |
Location | Naam van de locatie waar de ambulance ingezet is (Tekst) |
ShiftTemplateId | verwijzing naar SHIFTTEMPLATES (Integer) |
ShiftCode | De daadwerkelijke dienstcode (Tekst) (nieuw per 5 januari 2021) |
ChauffeurId | ResourceId van de ambulancechauffeur: dit is een verwijzing naar RESOURCES (Integer) |
ChauffeurName | De naam van de ambulancechauffeur (Tekst) (nieuw per 5 januari 2021) |
VerpleegkundigeId | ResourceId van de ambulanceverpleegkundige: dit is een verwijzing naar RESOURCES (Integer) |
VerpleegkundigeName | De naam van de ambulanceverpleegkundige (Tekst) (nieuw per 5 januari 2021) |
Verpleegkundige2Id | ResourceId van de eventuele tweede ambulanceverpleegkundige: dit is een verwijzing naar RESOURCES (Integer) |
Verpleegkundige2Name | De naam van de eventuele tweede ambulanceverpleegkundige (Tekst) (nieuw per 5 januari 2021) |
Remark | De opmerking op de daglijst (Tekst) (nieuw per 5 januari 2021). Dit is dezelfde waarde als in VEHICLEASSIGNMENTREMARKS |
ShiftTimeBegin | Begintijd dienst medewerker (Integer, in seconden vanaf 00:00 uur) |
ShiftTimeEnd | Eindtijd dienst medewerker (Integer, in seconden vanaf 00:00 uur) |
ShiftRemarks | Opmerking(en) van dienst(en) (Tekst, comma-separated indien meer dan één dienst een opmerking bevat) |
Inhoud
Een overzicht van de opmerkingen per standplaats bij de ambulance daglijsten.
Parameters
date (verplicht, datum voor welke de opmerkingen bij de daglijsten opgevraagd worden)
Velden in response
Location | Naam van de locatie waar de ambulance ingezet is (Tekst) |
|---|---|
Remark | de opmerking (Tekst) |
ResponseStatus codes
Iedere request aan de api zal een valide XML document als response teruggeven. De mogelijke document element tags van de response zijn:
<LoginResult>: indien een <Login> request aan de api gedaan is
<QueryResult>: indien een <Query> request aan de api gedaan is
<ErrorResult>: indien de request aan de api niet correct is
Iedere response heeft een <ResponseStatus> child tag. Hieronder zijn de mogelijke ResponseStatus codes beschreven
Algemeen
OK: alles is goed gegaan
NO-INPUT: de api heeft geen POST input ontvangen
NO-VALID-XML: de ontvangen POST input is geen valide XML document
UNKNOWN-FUNCTION: er wordt een onbekende API functie aangeroepen
NO_VALID_XML_SCHEMA: de ontvangen POST input is wel valide XML, de aangeroepen functie wordt ook herkend, maar de XML voldoet niet aan het XML schema van de aangeroepen functie
UNEXPECTED-ERROR: er is een onverwachte fout opgetreden
Login
NO-USERNAME: er is geen gebruikersnaam meegestuurd
NO-PASSWORD: er is geen wachtwoord meegestuurd
NOT-AUTHORIZED: gebruiker heeft geen toegang tot de api
NO-VALID-CREDENTIALS: opgegeven combinatie gebuikersnaam / wachtwoord is niet correct
Query
NO-VALID-SESSION: er is geen valide sessie id meegestuurd
NO-QUERY: er is geen query id meegestuurd
NO-VALID-QUERY: er is geen correcte query id meegestuurd
NO-PARAMETERS: de opgegeven query verwacht parameters, maar er zijn geen parameters meegestuurd
PARAMETER-NO-NAME: er is een parameter zonder naam meegestuurd
PARAMETER-NO-VALID-NAME: er is een parameter met een verkeerde naam meegestuurd
PARAMETER-ALREADY-SET: dezelfde parameter wordt meer dan één keer meegestuurd
PARAMETER-NO-VALID-VALUE: er wordt een niet-toegestane waarde voor een parameter meegestuurd
PARAMETER-NOT-SET: een verplichte parameter is niet meegestuurd
QUERY-EXECUTE-ERROR: er is een onverwachte database fout opgetreden in het uitvoeren van de query
QUERY-RESULT-ERROR: er is een onverwachte fout opgetreden in het verwerken van de query resultaten