Sidebar
This is an old revision of the document!
Table of Contents
Sales.GetProspect
Method: sales/GetProspect
Get a sale prospect via id
/// <param name="token"></param>
/// <param name="id"></param>
Example’s: 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”}
Sales.GetProspects
Method: sales/GetProspects
Get list of sale prospect
/// <param name="token"></param>
Example’s: 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”:“”}]
Sales.AddProspect
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
Sales.UpdateProspect
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>
Result:{“Id”:9,“OwnerId”:1,“OwnerName”:“Demo Brussels”,“FullName”:“John Doe”}
Sales.DeleteProspect
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
Sales.AddCalendarItem
Method: Sales/AddCalendarItem
Add an item to a given calendar
/// <param name="token"></param>
/// <param name="employeeid">id of the employee</param>
/// <param name="calendarid">id of the sales calendar</param>
/// <param name="fromdate"></param>
/// <param name="todate"></param>
/// <param name="description">description of the event</param>
/// <param name="note">optional</param>
/// <param name="saleid">optional</param>
/// <param name="from">optional</param>
