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 Foundation
import ServiceStack

// @ValidateRequest(Validator="IsAuthenticated")
public class GDPRCustomerQuery : ICompany, Codable
{
    /**
    * 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")
    public var companyId:String?

    /**
    * Id of the customer
    */
    // @ApiMember(Description="Id of the customer", IsRequired=true, ParameterType="path")
    public var customerId:String

    required public init(){}
}

public class GDPRCustomerQueryResponse : Codable
{
    public var bookings:[GDPRCustomerBookingsResponse] = []
    public var messageLog:[GDPRCustomerMessageLogResponse] = []
    public var userProfile:UserProfileResponse
    public var customer:GDPRCustomerInfoResponse
    public var customerComment:[GDPRCustomerCommentsResponse] = []
    public var newsletterLog:[GDPRCustomerNewsletterLogResponse] = []
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class GDPRCustomerBookingsResponse : Codable
{
    public var companyId:String
    public var id:Int
    public var customerId:String
    public var serviceId:Int
    public var statusId:Int
    public var from:Date
    public var to:Date
    public var unbookedOn:Date?
    public var unbookedComments:String
    public var bookedComments:String
    public var bookedBy:String
    public var comments:String
    public var textField1:String
    public var textField2:String
    public var textField3:String
    public var textField4:String
    public var textField5:String
    public var textField6:String
    public var textField7:String
    public var textField8:String
    public var textField9:String
    public var textField10:String
    public var textField11:String
    public var textField12:String
    public var textField13:String
    public var textField14:String
    public var textField15:String
    public var textField16:String
    public var textField17:String
    public var textField18:String
    public var textField19:String
    public var textField20:String
    public var updatedDate:Date
    public var createdDate:Date
    public var commentsToCustomer:String

    required public init(){}
}

public class GDPRCustomerMessageLogResponse : Codable
{
    public var companyId:String
    public var id:Int
    public var bookingId:Int?
    public var receiver:String
    public var sender:String
    public var messageTitle:String
    public var messageBody:String
    public var createdBy:String
    public var created:Date
    public var sent:Bool
    public var sentDate:Date?
    public var sendMethodId:Int

    required public init(){}
}

public class UserProfileResponse : Codable
{
    public var id:String
    public var firstname:String
    public var lastname:String
    public var phone:String
    public var email:String

    required public init(){}
}

public class GDPRCustomerInfoResponse : Codable
{
    public var userId:String
    public var firstname:String
    public var lastname:String
    public var phone:String
    public var email:String
    public var active:Bool
    public var facebookUsername:String
    public var textField1:String
    public var textField2:String
    public var textField3:String
    public var textField4:String
    public var textField5:String
    public var textField6:String
    public var textField7:String
    public var textField8:String
    public var textField9:String
    public var textField10:String
    public var textField11:String
    public var textField12:String
    public var textField13:String
    public var textField14:String
    public var textField15:String
    public var textField16:String
    public var textField17:String
    public var textField18:String
    public var textField19:String
    public var textField20:String
    public var updated:Date
    public var created:Date

    required public init(){}
}

public class GDPRCustomerCommentsResponse : Codable
{
    public var companyId:String
    public var id:Int
    public var customerId:String
    public var comments:String
    public var updated:Date
    public var created:Date
    public var imageUrl:Uri

    required public init(){}
}

public class GDPRCustomerNewsletterLogResponse : Codable
{
    public var companyId:String
    public var id:Int
    public var newslettersId:Int?
    public var receiver:String
    public var sender:String
    public var messageTitle:String
    public var messageBody:String
    public var sent:Bool
    public var created:Date

    required public init(){}
}

Swift GDPRCustomerQuery DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: testapi.bokamera.se 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
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"}}}