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.
import java.math.*
import java.util.*
import net.servicestack.client.*


@ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
@ValidateRequest(Validator="IsAuthenticated")
open class GDPRInactiveCustomerQuery : ICompany
{
    /**
    * The company id, if empty will use the company id for the user you are logged in with.
    */
    @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
    var CompanyId:UUID? = null

    /**
    * Inactive customers since the date. Inactive means they haven't done any bookings since that date.
    */
    @ApiMember(Description="Inactive customers since the date. Inactive means they haven't done any bookings since that date.", IsRequired=true)
    var InactiveSince:Date? = null

    /**
    * If you want to include the full customer information in the response
    */
    @ApiMember(Description="If you want to include the full customer information in the response")
    var IncludeCustomerInformation:Boolean? = null
}

open class InactiveCustomerResponse
{
    var Id:UUID? = null
    var Customer:InactiveCustomerInfo? = null
}

open class InactiveCustomerInfo
{
    var Id:UUID? = null
    var Firstname:String? = null
    var Lastname:String? = null
    var Email:String? = null
    var Phone:String? = null
    var FacebookUserName:String? = null
    var ImageUrl:Uri? = null
}

Kotlin GDPRInactiveCustomerQuery DTOs

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 /gdpr/customers/inactive HTTP/1.1 
Host: api.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
	}
}