CampaignTypes
| API | Description |
|---|---|
| POST search |
No documentation available. |
| GET api/CampaignTypes |
No documentation available. |
| GET api/CampaignTypes/{id} |
No documentation available. |
| POST api/CampaignTypes |
No documentation available. |
| PUT api/CampaignTypes/{id} |
No documentation available. |
| DELETE api/CampaignTypes/{id} |
No documentation available. |
SalesPerson
| API | Description |
|---|---|
| GET api/salesperson/{id} |
No documentation available. |
| GET api/salesperson/address/{addressId} |
No documentation available. |
| GET api/salesperson/user/{userId} |
No documentation available. |
| GET api/salesperson/GetAvailableSalesPeople/{appointmentId} |
No documentation available. |
| GET api/salesperson/Key/{key} |
No documentation available. |
| PUT api/salesperson/{id} |
No documentation available. |
| DELETE api/salesperson/{id} |
No documentation available. |
| GET api/SalesPerson |
No documentation available. |
| POST api/SalesPerson |
No documentation available. |
Communications
The Communications controller. Provides REST actions around managing the Communication entities.
| API | Description |
|---|---|
| GET api/communications/{id} |
Returns the communication with the given . |
| GET api/communications/event/{eventId} |
Returns the communication with the given . |
| GET api/communications/campaign/{campaignId} |
Returns the communication with the given . |
| POST api/communications/search |
No documentation available. |
| POST api/communications |
Creates a communication from the given . |
| PUT api/communications/{id} |
Updates a communication from the given . |
| DELETE api/communications/{id} |
Deletes the communication with the given . |
Unsubscribes
The unsubscribes controller.
| API | Description |
|---|---|
| GET api/unsubscribes |
Returns all the unsubscribes. |
| GET api/unsubscribes/{id} |
Returns the unsubscribe with the given . |
| GET api/unsubscribes/company/{companyId} |
Returns the unsubscribes for the given . |
| GET api/unsubscribes/person/{personId} |
Returns the unsubscribes for the given . |
| GET api/unsubscribes/key/{key} |
Returns the unsubscribe for the given . |
| POST api/unsubscribes |
Creates the given . |
| POST api/unsubscribes/create/{key} |
Creates an unsubscribe for the given . |
| PUT api/unsubscribes/{id} |
Updates the given . |
| DELETE api/unsubscribes/{id} |
Deletes the unsubscribe with the given . |
Address
The address controller.
| API | Description |
|---|---|
| GET api/address/{id} |
Gets the address with the given . |
| GET api/address/company/{companyId} |
Returns all addresses with the given . |
| GET api/address/company |
No documentation available. |
| GET api/address/person/{personId} |
Returns all addresses with the given . |
| GET api/address/person |
No documentation available. |
| POST api/address |
Adds the given . |
| POST api/address/search |
No documentation available. |
| GET api/address/propertyvalues/{name} |
No documentation available. |
| POST api/address/propertyvalues |
No documentation available. |
| PUT api/address/{id} |
Updates the given . |
| POST api/address/updatestatuses |
No documentation available. |
| DELETE api/address/{id} |
Deletes the address with the given . |
Appointments
The appointments controller. Provides REST actions for appointments.
| API | Description |
|---|---|
| GET api/appointments/{id} |
Returns the appointment with the given . |
| GET api/appointments/key/{key} |
Returns the appointments by the given . |
| POST api/appointments/key/{key} |
Sets the selected invite using the pUrl key for the given appointment time. |
| GET api/appointments/event/{eventId} |
Returns all appointments with the given . |
| GET api/appointments/event/days/{eventId} |
Returns the grouped appointments for the given . |
| GET api/appointments/invite/{inviteId} |
Returns the appointment with the given . |
| GET api/appointments/person/{personId} |
Returns the appointments with the given . |
| GET api/appointments/availability/{id} |
Returns the availability of the appointment with the given . |
| POST api/appointments |
Creates an appointment from the given . |
| POST api/appointments/selectproducts/{key} |
No documentation available. |
| PUT api/appointments/{id} |
Updates the appointment from the given . |
| DELETE api/appointments/{id} |
Deletes the appointment with the given . |
Company
The company controller.
| API | Description |
|---|---|
| GET api/company |
Gets all companies. |
| GET api/company/{id} |
Gets the company with the given |
| POST api/company |
Creates a new company. |
| POST api/company/search |
Returns companies that match the given . |
| PUT api/company/{id} |
Updates the given . |
| DELETE api/company/{id} |
Deletes the company with the given . |
Campaigns
The campaigns controller.
| API | Description |
|---|---|
| GET api/campaigns |
Gets all campaigns. |
| GET api/campaigns/{id} |
Gets the campaign with the given . |
| POST api/campaigns/search |
No documentation available. |
| POST api/campaigns |
Creates the given . |
| PUT api/campaigns/{id} |
Updates the given . |
| DELETE api/campaigns/{id} |
Deletes the campaign with the given . |
CommunicationInteractions
The Communication Interaction controller. Provides REST.
| API | Description |
|---|---|
| GET api/communicationinteractions/{id} |
Returns the communication interaction with the given . |
| GET api/communicationinteractions/communication/{communicationId} |
Returns the communication interactions with the given . |
| GET api/communicationinteractions/invite/{inviteId} |
Returns the communication interaction with the given . |
| POST api/communicationinteractions/key/{key} |
Updates the personal details based on the given using the . |
| POST api/communicationinteractions |
Creates a communication interaction from the given . |
| PUT api/communicationinteractions/{id} |
Updates a communication interaction from the given . |
| DELETE api/communicationinteractions/{id} |
Deletes the communication interaction with the given . |
WorkingHours
| API | Description |
|---|---|
| GET api/workinghours/{id} |
No documentation available. |
| GET api/workinghours/address/{addressId} |
No documentation available. |
| GET api/workinghours/address/{addressId}/key/{key} |
No documentation available. |
| GET api/workinghours/salesperson/{salesPersonId} |
No documentation available. |
| PUT api/workinghours/{id} |
No documentation available. |
| DELETE api/workinghours/{id} |
No documentation available. |
| GET api/WorkingHours |
No documentation available. |
| POST api/WorkingHours |
No documentation available. |
PromotionalEvents
| API | Description |
|---|---|
| GET api/promotionalevents/{id} |
Returns the event with the given . |
| POST api/promotionalevents |
Saves the given . |
| POST api/promotionalevents/search |
Performs a search of promotional events based on the given . |
| POST api/promotionalevents/initialise |
No documentation available. |
| PUT api/promotionalevents/{id} |
Updates the given . |
| DELETE api/promotionalevents/{id} |
Deletes the event with the given . |
CommunicationTemplates
| API | Description |
|---|---|
| GET api/CommunicationTemplates/{id} |
No documentation available. |
| DELETE api/CommunicationTemplates/{id} |
No documentation available. |
| GET api/CommunicationTemplates |
No documentation available. |
| POST api/CommunicationTemplates |
No documentation available. |
| PUT api/CommunicationTemplates/{id} |
No documentation available. |
Person
The Person controller.
| API | Description |
|---|---|
| GET api/person |
Returns all the people. |
| GET api/person/{id} |
Returns the person with the given . |
| GET api/person/invite/{inviteId} |
Returns the person with the given . |
| GET api/person/address/{addressId} |
Returns the person with the given . |
| GET api/person/event/{eventId} |
Returns the people related to the given . |
| GET api/person/securitygroup/{securityGroupId} |
No documentation available. |
| GET api/person/branchAddress/{eventAddress}?branchAddress={branchAddress} |
No documentation available. |
| POST api/person/key/{key} |
Updates the personal details based on the given using the . |
| POST api/person |
Creates a person from the given . |
| PUT api/person/{id} |
Updates a person from the given . |
| DELETE api/person/{id} |
Deletes the person with the given . |
Reporting
The reporting controller.
| API | Description |
|---|---|
| GET api/reporting/appointments/address |
Returns the s with the count of appointments and conversions by address. |
| GET api/reporting/appointments/brand |
No documentation available. |
| GET api/reporting/appointments/Campaign |
No documentation available. |
| GET api/reporting/appointments/CampaignType |
No documentation available. |
| GET api/reporting/appointments/CommunicationType |
No documentation available. |
| GET api/reporting/appointments/company |
Returns the s with the count of appointments and conversions by company. |
| GET api/reporting/appointments/currentsalesperson |
No documentation available. |
| GET api/reporting/appointments/locality |
Returns the s with the count of appointments and conversions by locality. |
| GET api/reporting/appointments/PurchasedProduct |
No documentation available. |
| GET api/reporting/appointments/salesperson |
Returns the s with the count of appointments and conversions by sales person. |
| GET api/reporting/appointments/event |
Returns the s with the count of appointments and conversions by event. |
| GET api/reporting/appointments/date |
Returns the s with the count of appointments and conversions by date. |
| GET api/reporting/invites |
Returns the s with the count of invites and conversions. |
| GET api/reporting/invites/address |
Returns the s with the count of invites and conversions by event address. |
| GET api/reporting/invites/campaign |
Returns the s with the count of invites and conversions by campaign. |
| GET api/reporting/invites/company |
Returns the s with the count of invites and conversions by company. |
| GET api/reporting/invites/event |
Returns the s with the count of invites and conversions by event. |
| GET api/reporting/invites/locality |
Returns the s with the count of invites and conversions by event address locality. |
| POST api/reporting/events/date |
No documentation available. |
| POST api/reporting/events/interactions/type |
No documentation available. |
| POST api/reporting/campaigns/interactions/type |
No documentation available. |
| POST api/reporting/people/companyaddresses |
No documentation available. |
Invites
The invites controller. Provides REST actions for invites.
| API | Description |
|---|---|
| GET api/invites/{id} |
Returns the invite with the given . |
| GET api/invites/key/{key} |
Returns the invite with the given . |
| GET api/invites/event/{eventId} |
Returns all the invites for the event with the given . |
| GET api/invites/person/{personId} |
Returns all the invites for the person with the given . |
| POST api/invites/search |
Returns all the invites that match the given . |
| POST api/invites/persons/search |
No documentation available. |
| POST api/invites |
Creates an invite from the given |
| PUT api/invites/{id} |
Updates the invite from the given . |
| DELETE api/invites/{id} |
Deletes the invite with the given . |