Requires any of the roles: | bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read |
GET | /gdpr/customers/{CustomerId} | Get all customer information stored on the customer | Get 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
{
/**
* List of all bookings associated with the customer
*/
@ApiMember(Description="List of all bookings associated with the customer")
var Bookings:ArrayList<GDPRCustomerBookingsResponse> = ArrayList<GDPRCustomerBookingsResponse>()
/**
* List of all message logs associated with the customer
*/
@ApiMember(Description="List of all message logs associated with the customer")
var MessageLog:ArrayList<GDPRCustomerMessageLogResponse> = ArrayList<GDPRCustomerMessageLogResponse>()
/**
* The user profile information for the customer
*/
@ApiMember(Description="The user profile information for the customer")
var UserProfile:UserProfileResponse? = null
/**
* Detailed customer information
*/
@ApiMember(Description="Detailed customer information")
var Customer:GDPRCustomerInfoResponse? = null
/**
* List of all comments associated with the customer
*/
@ApiMember(Description="List of all comments associated with the customer")
var CustomerComment:ArrayList<GDPRCustomerCommentsResponse> = ArrayList<GDPRCustomerCommentsResponse>()
/**
* List of all newsletter logs associated with the customer
*/
@ApiMember(Description="List of all newsletter logs associated with the customer")
var NewsletterLog:ArrayList<GDPRCustomerNewsletterLogResponse> = ArrayList<GDPRCustomerNewsletterLogResponse>()
/**
* Response status information
*/
@ApiMember(Description="Response status information")
var ResponseStatus:ResponseStatus? = null
}
open class GDPRCustomerBookingsResponse
{
/**
* The company ID associated with this booking
*/
@ApiMember(Description="The company ID associated with this booking")
var CompanyId:UUID? = null
/**
* The unique identifier of the booking
*/
@ApiMember(Description="The unique identifier of the booking")
var Id:Int? = null
/**
* The customer ID associated with this booking
*/
@ApiMember(Description="The customer ID associated with this booking")
var CustomerId:UUID? = null
/**
* The service ID for this booking
*/
@ApiMember(Description="The service ID for this booking")
var ServiceId:Int? = null
/**
* The current status of the booking
*/
@ApiMember(Description="The current status of the booking")
var StatusId:Int? = null
/**
* The start date and time of the booking
*/
@ApiMember(Description="The start date and time of the booking")
var From:Date? = null
/**
* The end date and time of the booking
*/
@ApiMember(Description="The end date and time of the booking")
var To:Date? = null
/**
* The date when the booking was cancelled or unbooked
*/
@ApiMember(Description="The date when the booking was cancelled or unbooked")
var UnbookedOn:Date? = null
/**
* Comments added when the booking was cancelled
*/
@ApiMember(Description="Comments added when the booking was cancelled")
var UnbookedComments:String? = null
/**
* Comments added when the booking was created
*/
@ApiMember(Description="Comments added when the booking was created")
var BookedComments:String? = null
/**
* The name of the person who made the booking
*/
@ApiMember(Description="The name of the person who made the booking")
var BookedBy:String? = null
/**
* General comments about the booking
*/
@ApiMember(Description="General comments about the booking")
var Comments:String? = null
/**
* Custom text field 1
*/
@ApiMember(Description="Custom text field 1")
var TextField1:String? = null
/**
* Custom text field 2
*/
@ApiMember(Description="Custom text field 2")
var TextField2:String? = null
/**
* Custom text field 3
*/
@ApiMember(Description="Custom text field 3")
var TextField3:String? = null
/**
* Custom text field 4
*/
@ApiMember(Description="Custom text field 4")
var TextField4:String? = null
/**
* Custom text field 5
*/
@ApiMember(Description="Custom text field 5")
var TextField5:String? = null
/**
* Custom text field 6
*/
@ApiMember(Description="Custom text field 6")
var TextField6:String? = null
/**
* Custom text field 7
*/
@ApiMember(Description="Custom text field 7")
var TextField7:String? = null
/**
* Custom text field 8
*/
@ApiMember(Description="Custom text field 8")
var TextField8:String? = null
/**
* Custom text field 9
*/
@ApiMember(Description="Custom text field 9")
var TextField9:String? = null
/**
* Custom text field 10
*/
@ApiMember(Description="Custom text field 10")
var TextField10:String? = null
/**
* Custom text field 11
*/
@ApiMember(Description="Custom text field 11")
var TextField11:String? = null
/**
* Custom text field 12
*/
@ApiMember(Description="Custom text field 12")
var TextField12:String? = null
/**
* Custom text field 13
*/
@ApiMember(Description="Custom text field 13")
var TextField13:String? = null
/**
* Custom text field 14
*/
@ApiMember(Description="Custom text field 14")
var TextField14:String? = null
/**
* Custom text field 15
*/
@ApiMember(Description="Custom text field 15")
var TextField15:String? = null
/**
* Custom text field 16
*/
@ApiMember(Description="Custom text field 16")
var TextField16:String? = null
/**
* Custom text field 17
*/
@ApiMember(Description="Custom text field 17")
var TextField17:String? = null
/**
* Custom text field 18
*/
@ApiMember(Description="Custom text field 18")
var TextField18:String? = null
/**
* Custom text field 19
*/
@ApiMember(Description="Custom text field 19")
var TextField19:String? = null
/**
* Custom text field 20
*/
@ApiMember(Description="Custom text field 20")
var TextField20:String? = null
/**
* The date when the booking was last updated
*/
@ApiMember(Description="The date when the booking was last updated")
var UpdatedDate:Date? = null
/**
* The date when the booking was created
*/
@ApiMember(Description="The date when the booking was created")
var CreatedDate:Date? = null
/**
* Comments sent to the customer about this booking
*/
@ApiMember(Description="Comments sent to the customer about this booking")
var CommentsToCustomer:String? = null
}
open class GDPRCustomerMessageLogResponse
{
/**
* The company ID associated with this message
*/
@ApiMember(Description="The company ID associated with this message")
var CompanyId:UUID? = null
/**
* The unique identifier of the message
*/
@ApiMember(Description="The unique identifier of the message")
var Id:Int? = null
/**
* The booking ID this message is related to, if any
*/
@ApiMember(Description="The booking ID this message is related to, if any")
var BookingId:Int? = null
/**
* The recipient of the message
*/
@ApiMember(Description="The recipient of the message")
var Receiver:String? = null
/**
* The sender of the message
*/
@ApiMember(Description="The sender of the message")
var Sender:String? = null
/**
* The title or subject of the message
*/
@ApiMember(Description="The title or subject of the message")
var MessageTitle:String? = null
/**
* The body content of the message
*/
@ApiMember(Description="The body content of the message")
var MessageBody:String? = null
/**
* The name of the person who created the message
*/
@ApiMember(Description="The name of the person who created the message")
var CreatedBy:String? = null
/**
* The date when the message was created
*/
@ApiMember(Description="The date when the message was created")
var Created:Date? = null
/**
* Whether the message was successfully sent
*/
@ApiMember(Description="Whether the message was successfully sent")
var Sent:Boolean? = null
/**
* The date when the message was sent
*/
@ApiMember(Description="The date when the message was sent")
var SentDate:Date? = null
/**
* The method used to send the message (e.g., email, SMS)
*/
@ApiMember(Description="The method used to send the message (e.g., email, SMS)")
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
var InvoiceAddress:InvoiceAddressResponse? = null
}
open class InvoiceAddressResponse
{
var InvoiceAddressId:UUID? = null
var UserId:UUID? = null
var CorporateIdentityNumber:String? = null
var InvoiceAddress1:String? = null
var InvoiceAddress2:String? = null
var InvoiceCity:String? = null
var InvoicePostalCode:String? = null
var InvoiceCountryCode:String? = null
}
open class GDPRCustomerInfoResponse
{
/**
* The unique identifier of the user
*/
@ApiMember(Description="The unique identifier of the user")
var UserId:UUID? = null
/**
* The user's first name
*/
@ApiMember(Description="The user's first name")
var Firstname:String? = null
/**
* The user's last name
*/
@ApiMember(Description="The user's last name")
var Lastname:String? = null
/**
* The user's phone number
*/
@ApiMember(Description="The user's phone number")
var Phone:String? = null
/**
* The user's email address
*/
@ApiMember(Description="The user's email address")
var Email:String? = null
/**
* Whether the user account is currently active
*/
@ApiMember(Description="Whether the user account is currently active")
var Active:Boolean? = null
/**
* The user's Facebook username
*/
@ApiMember(Description="The user's Facebook username")
var FacebookUsername:String? = null
/**
* Custom text field 1
*/
@ApiMember(Description="Custom text field 1")
var TextField1:String? = null
/**
* Custom text field 2
*/
@ApiMember(Description="Custom text field 2")
var TextField2:String? = null
/**
* Custom text field 3
*/
@ApiMember(Description="Custom text field 3")
var TextField3:String? = null
/**
* Custom text field 4
*/
@ApiMember(Description="Custom text field 4")
var TextField4:String? = null
/**
* Custom text field 5
*/
@ApiMember(Description="Custom text field 5")
var TextField5:String? = null
/**
* Custom text field 6
*/
@ApiMember(Description="Custom text field 6")
var TextField6:String? = null
/**
* Custom text field 7
*/
@ApiMember(Description="Custom text field 7")
var TextField7:String? = null
/**
* Custom text field 8
*/
@ApiMember(Description="Custom text field 8")
var TextField8:String? = null
/**
* Custom text field 9
*/
@ApiMember(Description="Custom text field 9")
var TextField9:String? = null
/**
* Custom text field 10
*/
@ApiMember(Description="Custom text field 10")
var TextField10:String? = null
/**
* Custom text field 11
*/
@ApiMember(Description="Custom text field 11")
var TextField11:String? = null
/**
* Custom text field 12
*/
@ApiMember(Description="Custom text field 12")
var TextField12:String? = null
/**
* Custom text field 13
*/
@ApiMember(Description="Custom text field 13")
var TextField13:String? = null
/**
* Custom text field 14
*/
@ApiMember(Description="Custom text field 14")
var TextField14:String? = null
/**
* Custom text field 15
*/
@ApiMember(Description="Custom text field 15")
var TextField15:String? = null
/**
* Custom text field 16
*/
@ApiMember(Description="Custom text field 16")
var TextField16:String? = null
/**
* Custom text field 17
*/
@ApiMember(Description="Custom text field 17")
var TextField17:String? = null
/**
* Custom text field 18
*/
@ApiMember(Description="Custom text field 18")
var TextField18:String? = null
/**
* Custom text field 19
*/
@ApiMember(Description="Custom text field 19")
var TextField19:String? = null
/**
* Custom text field 20
*/
@ApiMember(Description="Custom text field 20")
var TextField20:String? = null
/**
* The date when the customer information was last updated
*/
@ApiMember(Description="The date when the customer information was last updated")
var Updated:Date? = null
/**
* The date when the customer information was created
*/
@ApiMember(Description="The date when the customer information was created")
var Created:Date? = null
}
open class GDPRCustomerCommentsResponse
{
/**
* The company ID associated with this comment
*/
@ApiMember(Description="The company ID associated with this comment")
var CompanyId:UUID? = null
/**
* The unique identifier of the comment
*/
@ApiMember(Description="The unique identifier of the comment")
var Id:Int? = null
/**
* The customer ID this comment is associated with
*/
@ApiMember(Description="The customer ID this comment is associated with")
var CustomerId:UUID? = null
/**
* The content of the comment
*/
@ApiMember(Description="The content of the comment")
var Comments:String? = null
/**
* The date when the comment was last updated
*/
@ApiMember(Description="The date when the comment was last updated")
var Updated:Date? = null
/**
* The date when the comment was created
*/
@ApiMember(Description="The date when the comment was created")
var Created:Date? = null
/**
* URL to any image associated with the comment
*/
@ApiMember(Description="URL to any image associated with the comment")
var ImageUrl:Uri? = null
}
open class GDPRCustomerNewsletterLogResponse
{
/**
* The company ID associated with this newsletter
*/
@ApiMember(Description="The company ID associated with this newsletter")
var CompanyId:UUID? = null
/**
* The unique identifier of the newsletter log entry
*/
@ApiMember(Description="The unique identifier of the newsletter log entry")
var Id:Int? = null
/**
* The newsletter ID this log entry is related to, if any
*/
@ApiMember(Description="The newsletter ID this log entry is related to, if any")
var NewslettersId:Int? = null
/**
* The recipient of the newsletter
*/
@ApiMember(Description="The recipient of the newsletter")
var Receiver:String? = null
/**
* The sender of the newsletter
*/
@ApiMember(Description="The sender of the newsletter")
var Sender:String? = null
/**
* The title or subject of the newsletter
*/
@ApiMember(Description="The title or subject of the newsletter")
var MessageTitle:String? = null
/**
* The body content of the newsletter
*/
@ApiMember(Description="The body content of the newsletter")
var MessageBody:String? = null
/**
* Whether the newsletter was successfully sent
*/
@ApiMember(Description="Whether the newsletter was successfully sent")
var Sent:Boolean? = null
/**
* The date when the newsletter was created
*/
@ApiMember(Description="The date when the newsletter was created")
var Created:Date? = null
}
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 /gdpr/customers/{CustomerId} HTTP/1.1 Host: api.bokamera.se Accept: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <GDPRCustomerQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos"> <Bookings> <GDPRCustomerBookingsResponse> <BookedBy>String</BookedBy> <BookedComments>String</BookedComments> <Comments>String</Comments> <CommentsToCustomer>String</CommentsToCustomer> <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId> <CreatedDate>0001-01-01T00:00:00</CreatedDate> <CustomerId>00000000-0000-0000-0000-000000000000</CustomerId> <From>0001-01-01T00:00:00</From> <Id>0</Id> <ServiceId>0</ServiceId> <StatusId>0</StatusId> <TextField1>String</TextField1> <TextField10>String</TextField10> <TextField11>String</TextField11> <TextField12>String</TextField12> <TextField13>String</TextField13> <TextField14>String</TextField14> <TextField15>String</TextField15> <TextField16>String</TextField16> <TextField17>String</TextField17> <TextField18>String</TextField18> <TextField19>String</TextField19> <TextField2>String</TextField2> <TextField20>String</TextField20> <TextField3>String</TextField3> <TextField4>String</TextField4> <TextField5>String</TextField5> <TextField6>String</TextField6> <TextField7>String</TextField7> <TextField8>String</TextField8> <TextField9>String</TextField9> <To>0001-01-01T00:00:00</To> <UnbookedComments>String</UnbookedComments> <UnbookedOn>0001-01-01T00:00:00</UnbookedOn> <UpdatedDate>0001-01-01T00:00:00</UpdatedDate> </GDPRCustomerBookingsResponse> </Bookings> <Customer> <Active>false</Active> <Created>0001-01-01T00:00:00</Created> <Email>String</Email> <FacebookUsername>String</FacebookUsername> <Firstname>String</Firstname> <Lastname>String</Lastname> <Phone>String</Phone> <TextField1>String</TextField1> <TextField10>String</TextField10> <TextField11>String</TextField11> <TextField12>String</TextField12> <TextField13>String</TextField13> <TextField14>String</TextField14> <TextField15>String</TextField15> <TextField16>String</TextField16> <TextField17>String</TextField17> <TextField18>String</TextField18> <TextField19>String</TextField19> <TextField2>String</TextField2> <TextField20>String</TextField20> <TextField3>String</TextField3> <TextField4>String</TextField4> <TextField5>String</TextField5> <TextField6>String</TextField6> <TextField7>String</TextField7> <TextField8>String</TextField8> <TextField9>String</TextField9> <Updated>0001-01-01T00:00:00</Updated> <UserId>00000000-0000-0000-0000-000000000000</UserId> </Customer> <CustomerComment> <GDPRCustomerCommentsResponse> <Comments>String</Comments> <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId> <Created>0001-01-01T00:00:00</Created> <CustomerId>00000000-0000-0000-0000-000000000000</CustomerId> <Id>0</Id> <ImageUrl i:nil="true" /> <Updated>0001-01-01T00:00:00</Updated> </GDPRCustomerCommentsResponse> </CustomerComment> <MessageLog> <GDPRCustomerMessageLogResponse> <BookingId>0</BookingId> <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId> <Created>0001-01-01T00:00:00</Created> <CreatedBy>String</CreatedBy> <Id>0</Id> <MessageBody>String</MessageBody> <MessageTitle>String</MessageTitle> <Receiver>String</Receiver> <SendMethodId>0</SendMethodId> <Sender>String</Sender> <Sent>false</Sent> <SentDate>0001-01-01T00:00:00</SentDate> </GDPRCustomerMessageLogResponse> </MessageLog> <NewsletterLog> <GDPRCustomerNewsletterLogResponse> <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId> <Created>0001-01-01T00:00:00</Created> <Id>0</Id> <MessageBody>String</MessageBody> <MessageTitle>String</MessageTitle> <NewslettersId>0</NewslettersId> <Receiver>String</Receiver> <Sender>String</Sender> <Sent>false</Sent> </GDPRCustomerNewsletterLogResponse> </NewsletterLog> <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types"> <d2p1:ErrorCode>String</d2p1:ErrorCode> <d2p1:Message>String</d2p1:Message> <d2p1:StackTrace>String</d2p1:StackTrace> <d2p1:Errors> <d2p1:ResponseError> <d2p1:ErrorCode>String</d2p1:ErrorCode> <d2p1:FieldName>String</d2p1:FieldName> <d2p1:Message>String</d2p1:Message> <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:KeyValueOfstringstring> <d5p1:Key>String</d5p1:Key> <d5p1:Value>String</d5p1:Value> </d5p1:KeyValueOfstringstring> </d2p1:Meta> </d2p1:ResponseError> </d2p1:Errors> <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringstring> <d3p1:Key>String</d3p1:Key> <d3p1:Value>String</d3p1:Value> </d3p1:KeyValueOfstringstring> </d2p1:Meta> </ResponseStatus> <UserProfile> <Email>String</Email> <Firstname>String</Firstname> <Id>00000000-0000-0000-0000-000000000000</Id> <InvoiceAddress> <CorporateIdentityNumber>String</CorporateIdentityNumber> <InvoiceAddress1>String</InvoiceAddress1> <InvoiceAddress2>String</InvoiceAddress2> <InvoiceAddressId>00000000-0000-0000-0000-000000000000</InvoiceAddressId> <InvoiceCity>String</InvoiceCity> <InvoiceCountryCode>String</InvoiceCountryCode> <InvoicePostalCode>String</InvoicePostalCode> <UserId>00000000-0000-0000-0000-000000000000</UserId> </InvoiceAddress> <Lastname>String</Lastname> <Phone>String</Phone> </UserProfile> </GDPRCustomerQueryResponse>