Appointment Collection

To manage the appointments you can use this endpoint collection.

New appointment (create)

POST /appointment/create

This endpoint allows you to create an appointment. In case the appointment is about a new consumer, which is determined by the membership number, a dossier is created as well. Otherwise the appointment will be created in an existing dossier.

Note

The provided advisor within this call will also be the dossier advisor.

Request

Parameter Type Required Description Since
membershipnumber string No Your identification number for this consumer  
gender enum(‘male’, ‘female’) No    
initials string No    
lastnameprefix string No e.g. “van der”  
lastname string No    
address string No Street name  
addressnumber int No    
addressaddition string No    
postalcode string No    
city string No    
dateofbirth date(‘YYYY-MM-DD’) No   19.9.20
telephone string No    
mobilephone string No    
email1 string Yes Primary email  
email2 string No Secondary email  
incometypeid string No The code of an income-type defined in Accelerate 19.9.18
consumerprofileid string No The code of a consumer-profile defined in Accelerate 19.9.18
partner Consumer No Optionally provide a partner, see its properties below 19.9.16
appointmentid string No Our backend will generate an id if none was provided  
appointmenttype string No The appointment type code as defined in Accelerate  
appointmenttime datetime(‘YYYY-MM-DD HH:MM:SS’) Yes Start datetime of the appointment  
appointmentduration time(‘HH:MM:SS’) No When none provided, the default duration of the appointment type is used  
advisorid string Yes The advisor (employee) code defined in user management  
ownerid string Yes The dossier owner (employee) code defined in user management  
locationid string Yes The code of a location defined in Accelerate  
projectid string No The code of a project defined in Accelerate 19.9.18
campaignid string No The code of a campaign defined in Accelerate 19.9.18
leadsourceid string No The code of a leadsource defined in Accelerate  
productphaseid string No The code of a product-phase defined in Accelerate 19.9.18
remarks string No Comment  

Consumer

The consumer object consists of the following properties

Parameter Type Required Description Since
membershipnumber string No Your identification number for this consumer  
gender enum(‘male’, ‘female’) No    
initials string No    
lastnameprefix string No e.g. “van der”  
lastname string No    
address string No Street name  
addressnumber int No    
addressaddition string No    
postalcode string No    
city string No    
dateofbirth date(‘YYYY-MM-DD’) No   19.9.20
telephone string No    
mobilephone string No    
email1 string Yes Primary email  
email2 string No Secondary email  
incometypeid string No The code of an income-type defined in Accelerate 19.9.18
consumerprofileid string No The code of a consumer-profile defined in Accelerate 19.9.18

Response

Caution

Note: DOSSIER_ID returns the visual dossier code, the actual unique API_ID is returned as DOSSIER_API_ID

1
2
3
4
5
{
  "APPOINTMENT_ID" : "1234567_123",
  "DOSSIER_ID" : "ABC-123",
  "DOSSIER_API_ID" : "DS123ABC123ABC123ABC123ABC123ABC"
}

Errors

Here follows a list of errors that can occur while calling this endpoint.

Type Explanation
ERR_NO_ADVISOR_FOUND No advisor could be found with the provided advisorid
ERR_NO_LOCATION_FOUND No location could be found with the provided locationid
APPOINTMENT_TYPE_OR_DURATION_REQUIRED No appointmenttype or appointmentduration was provided
ERR_INVALID_APPOINTMENT_TYPE The appointmenttime was in invalid format
ERR_APPOINTMENT_ID_IN_USE The appointmentid was already used
NO_DEFAULT_OWNER_ON_ADVISOR The provided advisor has no default owner assigned
ERR_APPOINTMENT_PRODUCT_NOT_FOUND The provided advisor has no default owner assigned
PROJECT_COULD_NOT_BE_FOUND The provided advisor has no default owner assigned
INCOME_TYPE_COULD_NOT_BE_FOUND No income-type could be found (for one of the persons) with the provided incometypeid
CONSUMER_PROFILE_COULD_NOT_BE_FOUND No consumer-profile could be found (for one of the persons) with the provided consumerprofileid
CAMPAIGN_COULD_NOT_BE_FOUND No campaign could be found with the provided campaignid
PRODUCT_PHASE_COULD_NOT_BE_FOUND No product-phase could be found with the provided productphaseid
ERR_INVALID_LEAD_SOURCE No lead-source could be found with the provided leadsourceid

update

POST /appointment/update

It is possible to change the appointment time and type.

Request

Parameter Type Required Description
appointmentid string No The appointment you want to edit
appointmenttype string No The appointment type code as defined in Accelerate
appointmenttime datetime(‘YYYY-MM-DD HH:MM:SS’) Yes Start datetime of the appointment
appointmentduration time(‘HH:MM:SS’) No Duration of the appointment

Response

1
2
3
{
  "operation_result" : "ok"
}

info

GET /appointment/<id>/info

This request does not take any parameters, but it still requires Request signing. So only the current date and token need to be passed as query parameters, see the example request below.

Response

{
  "appointmentid"     : "1234567_123",
  "dossierid"         : "ABC-123",
  "membershipnumber"  : "CUST123",
  "appointmenttype"   : "INFO_MEETING",
  "appointmenttime"   : "2018-01-01 10:00:00",
  "advisorid"         : "EM123",
  "locationid"        : "LOC123"
}

Example request

https://connect.accelerate.demo/appointment/1234/info?date=2000-01-01+12%3A00%3A00&token=<TOKEN>

cancel

POST /appointment/cancel

Request

Parameter Type Required Description
appointmentid string No The appointment you want to cancel

Response

1
2
3
{
  "operation_result" : "ok"
}

types

GET /appointment/types

This endpoint returns all appointment-types.

Request

This request requires no parameters.

Response

1
2
3
4
5
6
[
  {
    "code": "TRUE_MEETING",
    "name": "TrueMeeting afspraak (videobellen)"
  }
]

Note

The property code can be used in the endpoints New dossier (createFromDossierRequest) and New appointment (create) to specify a certain appointmenttype