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
"use strict";
export class GDPRCustomerBookingsResponse {
    /** @param {{CompanyId?:string,Id?:number,CustomerId?:string,ServiceId?:number,StatusId?:number,From?:string,To?:string,UnbookedOn?:string,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,UpdatedDate?:string,CreatedDate?:string,CommentsToCustomer?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    CompanyId;
    /** @type {number} */
    Id;
    /** @type {string} */
    CustomerId;
    /** @type {number} */
    ServiceId;
    /** @type {number} */
    StatusId;
    /** @type {string} */
    From;
    /** @type {string} */
    To;
    /** @type {?string} */
    UnbookedOn;
    /** @type {string} */
    UnbookedComments;
    /** @type {string} */
    BookedComments;
    /** @type {string} */
    BookedBy;
    /** @type {string} */
    Comments;
    /** @type {string} */
    TextField1;
    /** @type {string} */
    TextField2;
    /** @type {string} */
    TextField3;
    /** @type {string} */
    TextField4;
    /** @type {string} */
    TextField5;
    /** @type {string} */
    TextField6;
    /** @type {string} */
    TextField7;
    /** @type {string} */
    TextField8;
    /** @type {string} */
    TextField9;
    /** @type {string} */
    TextField10;
    /** @type {string} */
    TextField11;
    /** @type {string} */
    TextField12;
    /** @type {string} */
    TextField13;
    /** @type {string} */
    TextField14;
    /** @type {string} */
    TextField15;
    /** @type {string} */
    TextField16;
    /** @type {string} */
    TextField17;
    /** @type {string} */
    TextField18;
    /** @type {string} */
    TextField19;
    /** @type {string} */
    TextField20;
    /** @type {string} */
    UpdatedDate;
    /** @type {string} */
    CreatedDate;
    /** @type {string} */
    CommentsToCustomer;
}
export class GDPRCustomerMessageLogResponse {
    /** @param {{CompanyId?:string,Id?:number,BookingId?:number,Receiver?:string,Sender?:string,MessageTitle?:string,MessageBody?:string,CreatedBy?:string,Created?:string,Sent?:boolean,SentDate?:string,SendMethodId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    CompanyId;
    /** @type {number} */
    Id;
    /** @type {?number} */
    BookingId;
    /** @type {string} */
    Receiver;
    /** @type {string} */
    Sender;
    /** @type {string} */
    MessageTitle;
    /** @type {string} */
    MessageBody;
    /** @type {string} */
    CreatedBy;
    /** @type {string} */
    Created;
    /** @type {boolean} */
    Sent;
    /** @type {?string} */
    SentDate;
    /** @type {number} */
    SendMethodId;
}
export class UserProfileResponse {
    /** @param {{Id?:string,Firstname?:string,Lastname?:string,Phone?:string,Email?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Id;
    /** @type {string} */
    Firstname;
    /** @type {string} */
    Lastname;
    /** @type {string} */
    Phone;
    /** @type {string} */
    Email;
}
export class GDPRCustomerInfoResponse {
    /** @param {{UserId?:string,Firstname?:string,Lastname?:string,Phone?:string,Email?:string,Active?:boolean,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,Updated?:string,Created?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    UserId;
    /** @type {string} */
    Firstname;
    /** @type {string} */
    Lastname;
    /** @type {string} */
    Phone;
    /** @type {string} */
    Email;
    /** @type {boolean} */
    Active;
    /** @type {string} */
    FacebookUsername;
    /** @type {string} */
    TextField1;
    /** @type {string} */
    TextField2;
    /** @type {string} */
    TextField3;
    /** @type {string} */
    TextField4;
    /** @type {string} */
    TextField5;
    /** @type {string} */
    TextField6;
    /** @type {string} */
    TextField7;
    /** @type {string} */
    TextField8;
    /** @type {string} */
    TextField9;
    /** @type {string} */
    TextField10;
    /** @type {string} */
    TextField11;
    /** @type {string} */
    TextField12;
    /** @type {string} */
    TextField13;
    /** @type {string} */
    TextField14;
    /** @type {string} */
    TextField15;
    /** @type {string} */
    TextField16;
    /** @type {string} */
    TextField17;
    /** @type {string} */
    TextField18;
    /** @type {string} */
    TextField19;
    /** @type {string} */
    TextField20;
    /** @type {string} */
    Updated;
    /** @type {string} */
    Created;
}
export class GDPRCustomerCommentsResponse {
    /** @param {{CompanyId?:string,Id?:number,CustomerId?:string,Comments?:string,Updated?:string,Created?:string,ImageUrl?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    CompanyId;
    /** @type {number} */
    Id;
    /** @type {string} */
    CustomerId;
    /** @type {string} */
    Comments;
    /** @type {string} */
    Updated;
    /** @type {string} */
    Created;
    /** @type {string} */
    ImageUrl;
}
export class GDPRCustomerNewsletterLogResponse {
    /** @param {{CompanyId?:string,Id?:number,NewslettersId?:number,Receiver?:string,Sender?:string,MessageTitle?:string,MessageBody?:string,Sent?:boolean,Created?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    CompanyId;
    /** @type {number} */
    Id;
    /** @type {?number} */
    NewslettersId;
    /** @type {string} */
    Receiver;
    /** @type {string} */
    Sender;
    /** @type {string} */
    MessageTitle;
    /** @type {string} */
    MessageBody;
    /** @type {boolean} */
    Sent;
    /** @type {string} */
    Created;
}
export class GDPRCustomerQueryResponse {
    /** @param {{Bookings?:GDPRCustomerBookingsResponse[],MessageLog?:GDPRCustomerMessageLogResponse[],UserProfile?:UserProfileResponse,Customer?:GDPRCustomerInfoResponse,CustomerComment?:GDPRCustomerCommentsResponse[],NewsletterLog?:GDPRCustomerNewsletterLogResponse[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {GDPRCustomerBookingsResponse[]} */
    Bookings;
    /** @type {GDPRCustomerMessageLogResponse[]} */
    MessageLog;
    /** @type {UserProfileResponse} */
    UserProfile;
    /** @type {GDPRCustomerInfoResponse} */
    Customer;
    /** @type {GDPRCustomerCommentsResponse[]} */
    CustomerComment;
    /** @type {GDPRCustomerNewsletterLogResponse[]} */
    NewsletterLog;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class GDPRCustomerQuery {
    /** @param {{CompanyId?:string,CustomerId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @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  */
    CompanyId;
    /**
     * @type {string}
     * @description Id of the customer */
    CustomerId;
}

JavaScript GDPRCustomerQuery DTOs

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/{CustomerId} HTTP/1.1 
Host: testapi.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>
    <Lastname>String</Lastname>
    <Phone>String</Phone>
  </UserProfile>
</GDPRCustomerQueryResponse>