BokaMera.API.Host

<back to all web services

NewsletterCustomerQuery

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read
The following routes are available for this service:
GET/newsletter/customersGet all customers that are valid for sending newsletters to.Get all customers that are valid for sending newsletters to.
NewsletterCustomerQuery Parameters:
NameParameterData TypeRequiredDescription
CompanyIdqueryGuid?NoThe company id, if empty will use the company id for the user you are logged in with.
CustomerMinBookingsqueryint?NoSearch for customer has done minimum number of bookings.
CustomerMaxBookingsqueryint?NoSearch for customer has done maximum number of bookings.
BookedServiceIdsqueryint[]YesSearch for customer has booked any of the service in the list (List contain service id's).
FromqueryDateTime?NoSearch interval From datetime .
ToqueryDateTime?NoSearch interval To datetime .
MaxRecordsqueryint?NoThe max number of records you want to collect
IncludeCustomerInformationqueryboolNoIf you want to include the full customer information in the response
NewsletterCustomerQueryResponse Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
CustomerformNewsletterCustomerInfoYes
NewsletterCustomerInfo Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
FirstnameformstringYes
LastnameformstringYes
EmailformstringYes
PhoneformstringYes
FacebookUserNameformstringYes
ImageUrlformUriYes

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /newsletter/customers HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Customer: 
	{
		Firstname: String,
		Lastname: String,
		Email: String,
		Phone: String,
		FacebookUserName: String
	}
}