BokaMera.API.Host

<back to all web services

GDPRInactiveCustomerQuery

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read
The following routes are available for this service:
GET/gdpr/customers/inactiveGet all customers that have been inactive due to the filtering.Get all customers that have been inactive due to the filtering you add in the request.
GDPRInactiveCustomerQuery Parameters:
NameParameterData TypeRequiredDescription
CompanyIdqueryGuid?NoThe company id, if empty will use the company id for the user you are logged in with.
InactiveSincequeryDateTimeYesInactive customers since the date. Inactive means they haven't done any bookings since that date.
IncludeCustomerInformationqueryboolNoIf you want to include the full customer information in the response
InactiveCustomerResponse Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
CustomerformInactiveCustomerInfoYes
InactiveCustomerInfo Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNoThe unique identifier of the customer
FirstnameformstringYesThe customer's first name
LastnameformstringYesThe customer's last name
EmailformstringYesThe customer's email address
PhoneformstringYesThe customer's phone number
FacebookUserNameformstringYesThe customer's Facebook username
ImageUrlformUriYesURL to the customer's profile image

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

HTTP + XML

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

GET /gdpr/customers/inactive HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<InactiveCustomerResponse 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>
</InactiveCustomerResponse>