BokaMera.API.Host

<back to all web services

GDPRCustomerQuery

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/{CustomerId}Get all customer information stored on the customerGet all information stored on the customer
import java.math.*
import java.util.*
import net.servicestack.client.*


@ValidateRequest(Validator="IsAuthenticated")
open class GDPRCustomerQuery : ICompany
{
    /**
    * Enter the company and id you want to see the information for a resource, if blank company id and you are an admin, your company id will be used. If blank id, all resources will be shown 
    */
    @ApiMember(Description="Enter the company and id you want to see the information for a resource, if blank company id and you are an admin, your company id will be used. If blank id, all resources will be shown ", IsRequired=true, ParameterType="query")
    var CompanyId:UUID? = null

    /**
    * Id of the customer
    */
    @ApiMember(Description="Id of the customer", IsRequired=true, ParameterType="path")
    var CustomerId:UUID? = null
}

open class GDPRCustomerQueryResponse
{
    var Bookings:ArrayList<GDPRCustomerBookingsResponse> = ArrayList<GDPRCustomerBookingsResponse>()
    var MessageLog:ArrayList<GDPRCustomerMessageLogResponse> = ArrayList<GDPRCustomerMessageLogResponse>()
    var UserProfile:UserProfileResponse? = null
    var Customer:GDPRCustomerInfoResponse? = null
    var CustomerComment:ArrayList<GDPRCustomerCommentsResponse> = ArrayList<GDPRCustomerCommentsResponse>()
    var NewsletterLog:ArrayList<GDPRCustomerNewsletterLogResponse> = ArrayList<GDPRCustomerNewsletterLogResponse>()
    var ResponseStatus:ResponseStatus? = null
}

open class GDPRCustomerBookingsResponse
{
    var CompanyId:UUID? = null
    var Id:Int? = null
    var CustomerId:UUID? = null
    var ServiceId:Int? = null
    var StatusId:Int? = null
    var From:Date? = null
    var To:Date? = null
    var UnbookedOn:Date? = null
    var UnbookedComments:String? = null
    var BookedComments:String? = null
    var BookedBy:String? = null
    var Comments:String? = null
    var TextField1:String? = null
    var TextField2:String? = null
    var TextField3:String? = null
    var TextField4:String? = null
    var TextField5:String? = null
    var TextField6:String? = null
    var TextField7:String? = null
    var TextField8:String? = null
    var TextField9:String? = null
    var TextField10:String? = null
    var TextField11:String? = null
    var TextField12:String? = null
    var TextField13:String? = null
    var TextField14:String? = null
    var TextField15:String? = null
    var TextField16:String? = null
    var TextField17:String? = null
    var TextField18:String? = null
    var TextField19:String? = null
    var TextField20:String? = null
    var UpdatedDate:Date? = null
    var CreatedDate:Date? = null
    var CommentsToCustomer:String? = null
}

open class GDPRCustomerMessageLogResponse
{
    var CompanyId:UUID? = null
    var Id:Int? = null
    var BookingId:Int? = null
    var Receiver:String? = null
    var Sender:String? = null
    var MessageTitle:String? = null
    var MessageBody:String? = null
    var CreatedBy:String? = null
    var Created:Date? = null
    var Sent:Boolean? = null
    var SentDate:Date? = null
    var SendMethodId:Int? = null
}

open class UserProfileResponse
{
    var Id:UUID? = null
    var Firstname:String? = null
    var Lastname:String? = null
    var Phone:String? = null
    var Email:String? = null
}

open class GDPRCustomerInfoResponse
{
    var UserId:UUID? = null
    var Firstname:String? = null
    var Lastname:String? = null
    var Phone:String? = null
    var Email:String? = null
    var Active:Boolean? = null
    var FacebookUsername:String? = null
    var TextField1:String? = null
    var TextField2:String? = null
    var TextField3:String? = null
    var TextField4:String? = null
    var TextField5:String? = null
    var TextField6:String? = null
    var TextField7:String? = null
    var TextField8:String? = null
    var TextField9:String? = null
    var TextField10:String? = null
    var TextField11:String? = null
    var TextField12:String? = null
    var TextField13:String? = null
    var TextField14:String? = null
    var TextField15:String? = null
    var TextField16:String? = null
    var TextField17:String? = null
    var TextField18:String? = null
    var TextField19:String? = null
    var TextField20:String? = null
    var Updated:Date? = null
    var Created:Date? = null
}

open class GDPRCustomerCommentsResponse
{
    var CompanyId:UUID? = null
    var Id:Int? = null
    var CustomerId:UUID? = null
    var Comments:String? = null
    var Updated:Date? = null
    var Created:Date? = null
    var ImageUrl:Uri? = null
}

open class GDPRCustomerNewsletterLogResponse
{
    var CompanyId:UUID? = null
    var Id:Int? = null
    var NewslettersId:Int? = null
    var Receiver:String? = null
    var Sender:String? = null
    var MessageTitle:String? = null
    var MessageBody:String? = null
    var Sent:Boolean? = null
    var Created:Date? = null
}

Kotlin GDPRCustomerQuery 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/{CustomerId} HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Bookings: 
	[
		{
			Id: 0,
			ServiceId: 0,
			StatusId: 0,
			UnbookedOn: "0001-01-01T00:00:00",
			UnbookedComments: String,
			BookedComments: String,
			BookedBy: String,
			Comments: String,
			TextField1: String,
			TextField2: String,
			TextField3: String,
			TextField4: String,
			TextField5: String,
			TextField6: String,
			TextField7: String,
			TextField8: String,
			TextField9: String,
			TextField10: String,
			TextField11: String,
			TextField12: String,
			TextField13: String,
			TextField14: String,
			TextField15: String,
			TextField16: String,
			TextField17: String,
			TextField18: String,
			TextField19: String,
			TextField20: String,
			CommentsToCustomer: String
		}
	],
	MessageLog: 
	[
		{
			Id: 0,
			BookingId: 0,
			Receiver: String,
			Sender: String,
			MessageTitle: String,
			MessageBody: String,
			CreatedBy: String,
			Sent: False,
			SentDate: "0001-01-01T00:00:00",
			SendMethodId: 0
		}
	],
	UserProfile: 
	{
		Firstname: String,
		Lastname: String,
		Phone: String,
		Email: String
	},
	Customer: 
	{
		Firstname: String,
		Lastname: String,
		Phone: String,
		Email: String,
		Active: False,
		FacebookUsername: String,
		TextField1: String,
		TextField2: String,
		TextField3: String,
		TextField4: String,
		TextField5: String,
		TextField6: String,
		TextField7: String,
		TextField8: String,
		TextField9: String,
		TextField10: String,
		TextField11: String,
		TextField12: String,
		TextField13: String,
		TextField14: String,
		TextField15: String,
		TextField16: String,
		TextField17: String,
		TextField18: String,
		TextField19: String,
		TextField20: String
	},
	CustomerComment: 
	[
		{
			Id: 0,
			Comments: String
		}
	],
	NewsletterLog: 
	[
		{
			Id: 0,
			NewslettersId: 0,
			Receiver: String,
			Sender: String,
			MessageTitle: String,
			MessageBody: String,
			Sent: False
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}