Requires any of the roles: | bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read |
GET | /newsletter/customers | Get all customers that are valid for sending newsletters to. | Get all customers that are valid for sending newsletters to. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CompanyId | query | Guid? | No | The company id, if empty will use the company id for the user you are logged in with. |
CustomerMinBookings | query | int? | No | Search for customer has done minimum number of bookings. |
CustomerMaxBookings | query | int? | No | Search for customer has done maximum number of bookings. |
BookedServiceIds | query | int[] | No | Search for customer has booked any of the service in the list (List contain service id's). |
From | query | DateTime? | No | Search interval From datetime . |
To | query | DateTime? | No | Search interval To datetime . |
MaxRecords | query | int? | No | The max number of records you want to collect |
IncludeCustomerInformation | query | bool | No | If you want to include the full customer information in the response |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | Guid | No | |
Customer | form | NewsletterCustomerInfo | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | Guid | No | |
Firstname | form | string | No | |
Lastname | form | string | No | |
form | string | No | ||
Phone | form | string | No | |
FacebookUserName | form | string | No | |
ImageUrl | form | Uri | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: api.bokamera.se Accept: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <NewsletterCustomerQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos"> <Customer> <Email>String</Email> <FacebookUserName>String</FacebookUserName> <Firstname>String</Firstname> <Id>00000000-0000-0000-0000-000000000000</Id> <ImageUrl i:nil="true" /> <Lastname>String</Lastname> <Phone>String</Phone> </Customer> <Id>00000000-0000-0000-0000-000000000000</Id> </NewsletterCustomerQueryResponse>