API WIKI

Method: sales/GetProspect

Get a sale prospect via id

      /// <param name="token"></param>
      /// <param name="id"></param> 
     

Example: https://demo.clubplanner.be/api/Sales/GetProspect?token=DEMOTOKEN&id=64

Result:

{“Id”:64,“OwnerId”:1,“Name”:“QSqs”,“Firstname”:“S<s”,“Male”:true,“Status”:1,“TelephoneNumber”:“”,“BirthDate”:“1900-01-01T00:00:00”,“Age”:119,“FullName”:“S<s QSqs”,“AddressLine”:“”,“FullAddress”:“”,“Zip”:“”,“City”:“”,“MobileNumber”:“”,“EmailAddress”:“”,“ProspectSource”:“Flyer”,“ProspectSubSource”:“Bedeling markt”}

Method: sales/GetProspects

Get list of sale prospect

      /// <param name="token"></param>  
      /// <param name="fromdate">optional</param>  
      /// <param name="todate">optional</param>  
     

Example: https://demo.clubplanner.be/api/Sales/GetProspects?token=DEMOTOKEN

Result:

[{“Id”:1,“OwnerId”:1,“Name”:“Do”,“Firstname”:“John”,“Male”:true,“Status”:0,“TelephoneNumber”:“”,“BirthDate”:“1900-01-01T00:00:00”,“Age”:119,“FullName”:“John Do”,“AddressLine”:“”,“FullAddress”:“”,“Zip”:“”,“City”:“”,“MobileNumber”:“”,“EmailAddress”:“”,“ProspectSource”:“”,“ProspectSubSource”:“”},{“Id”:2,“OwnerId”:1,“Name”:“Peter”,“Firstname”:“Peter”,“Male”:true,“Status”:1,“TelephoneNumber”:“”,“BirthDate”:“1900-01-01T00:00:00”,“Age”:119,“FullName”:“Peter Peter”,“AddressLine”:“”,“FullAddress”:“”,“Zip”:“”,“City”:“”,“MobileNumber”:“”,“EmailAddress”:“”,“ProspectSource”:“”,“ProspectSubSource”:“”}]

Method: Sales/AddProspect Adds a prospect to the sales module

      /// <param name="token"></param>
      /// <param name="firstname"></param>
      /// <param name="lastname"></param>
      /// <param name="addressline"></param>
      /// <param name="city"></param>
      /// <param name="zip"></param>
      /// <param name="email"></param>
      /// <param name="mobile"></param>
      /// <param name="dayofbirth"></param>
      /// <param name="owner"></param>
      /// <param name="note"></param>
      /// <param name="langid"></param>
      /// <param name="telephonenbr"></param>
      /// <param name="source"></param>
      /// <param name="subsource"></param>                
      /// <param name="from"></param>
      /// <param name="gender"></param>
      

Result:

  class AddSaleResult
  {
      public int Id { get; set; }
      public int OwnerId { get; set; }
      public string OwnerName { get; set; }
      public string FullName { get; set; }
  }
  

Example: https://demo.clubplanner.be/api/sales/AddProspect?token=DEMOTOKEN&firstname=John&lastname=Peterson

Method: Sales/UpdateProspect Update a prospect to the sales module

      /// <param name="token"></param>
      /// <param name="id"></param>
      /// <param name="firstname"></param>
      /// <param name="lastname"></param>
      /// <param name="addressline"></param>
      /// <param name="city"></param>
      /// <param name="zip"></param>
      /// <param name="email"></param>
      /// <param name="mobile"></param>
      /// <param name="dayofbirth"></param>
      /// <param name="owner"></param>
      /// <param name="note"></param>
      /// <param name="langid"></param>
      /// <param name="telephonenbr"></param>
      /// <param name="source"></param>
      /// <param name="subsource"></param>     
      /// <param name="from"></param>
      /// <param name="gender"></param>
      

Example: https://demo.clubplanner.be/api/sales/UpdateProspect?token=DEMOTOKEN&id=9&firstname=John&lastname=Doe&gender=F&dayofbirth=1910-01-01

Result:{“Id”:9,“OwnerId”:1,“OwnerName”:“Demo Brussels”,“FullName”:“John Doe”}

Method: Sales/DeleteProspect

Delete a sale prospect

      /// <param name="token"></param>
      /// <param name="id"></param>        

Example: https://demo.clubplanner.be/api/Sales/DeleteProspect?token=DEMOTOKEN&id=66

Method: Sales/DeleteCalendarItem

Removes a Sales CalendarItem

    /// <param name="token"></param>
    /// <param name="id">id of the item</param>
    /// <param name="from">optional</param>    

Example: https://demo.clubplanner.be/api/sales/DeleteCalendarItem?token=DEMOTOKEN&id=1

Returns a list with free timeslots for a given duration

    /// <param name="token"></param>
    /// <param name="calendarid">id of the calendar</param>
    /// <param name="date">date of the selected day</param>
    /// <param name="duration">duration in minutes</param>
    /// <param name="empid">id of the employee, optional, default 0 (=all)</param>

Example: https://demo.clubplanner.be/api/sales/GetFreeTimeslots?token=DEMOTOKEN&date=2025-03-01&calendarid=1&duration=60 https://demo.clubplanner.be/api/sales/GetFreeTimeslots?token=DEMOTOKEN&date=2025-03-01&calendarid=1&duration=60&empid=5

Method: sales/SetStepResult

Set the result of the current step and inserts the next step

      /// <param name="token"></param>
      /// <param name="id">id of prospect</param> 
      /// <param name="stepresultid">id of stepresult</param> 
      /// <param name="employeeid">id of the employee</param> 
      /// <param name="plannedemployeeid">optional, id of the employee that will be used for the appointment</param> 
      /// <param name="fromdate">optional</param> 
      /// <param name="todate">optional</param> 
      /// <param name="note">optional</param> 
      /// <param name="color">optional</param> 
     

Examples: https://demo.clubplanner.be/api/Sales/SetStepResult?token=DEMOTOKEN&id=64&stepresultid=1&employeeid=1

Set result + appointment: https://demo.clubplanner.be/api/Sales/SetStepResult?token=DEMOTOKEN&fromdate=2023-01-01T12:30:00&todate=2023-01-01T13:00:00&description=testdescription&calendarid=46&roomid=1

Result:

{

"CurrentStepId": 1091,
"Description": "",
"Results": [
  {
    "ResultId": 27,
    "Description": "Afspraak maken voor rondleiding "
  },
  {
    "ResultId": 28,
    "Description": "Afspraak maken voor proefles "
  },
  {
    "ResultId": 29,
    "Description": "Geen gehoor "
  },
  {
    "ResultId": 30,
    "Description": "Klant later terugbellen "
  },
  {
    "ResultId": 31,
    "Description": "Belmoment verplaatsen "
  },
  {
    "ResultId": 32,
    "Description": "Klant heeft geen interesse"
  },
  {
    "ResultId": 33,
    "Description": "Klant niet te bereiken, verkoopproces afronden"
  }
]

}

Method: sales/GetCurrentStep

Get the current step and possible results

      /// <param name="token"></param>
      /// <param name="id">id of prospect</param> 

Example: https://demo.clubplanner.be/api/sales/GetCurrentStep?token=DEMOTOKEN&id=1

Result:

{

"CurrentStepId": 1091,
"Description": "",
"Results": [
  {
    "ResultId": 27,
    "Description": "Afspraak maken voor rondleiding "
  },
  {
    "ResultId": 28,
    "Description": "Afspraak maken voor proefles "
  },
  {
    "ResultId": 29,
    "Description": "Geen gehoor "
  },
  {
    "ResultId": 30,
    "Description": "Klant later terugbellen "
  },
  {
    "ResultId": 31,
    "Description": "Belmoment verplaatsen "
  },
  {
    "ResultId": 32,
    "Description": "Klant heeft geen interesse"
  },
  {
    "ResultId": 33,
    "Description": "Klant niet te bereiken, verkoopproces afronden"
  }
]

}

Sales.GetCalendarItems Returns a list with all items in the given calendar

  /// <param name="token"></param>
  /// <param name="id">id of the calendar</param>
  /// <param name="date">date of the selected day</param>
  /// <param name="empid">id of the employee, optional, default 0 (=all)</param>

Example: https://demo.clubplanner.be/api/sales/getcalendarItems?token=DEMOTOKEN&id=1&date=19-NOV-2025