| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| GET | /voss/customers | Search voss customers by organization number, customer number or external id | Raw passthrough to the Voss customer search. Returns all matching customers with their full fields (externalId, customerNumber, expiryDate, ...). |
|---|
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BokaMera.API.ServiceModel.Dtos;
using BokaMera.VossIntegration.ApiTools.Model;
using BokaMera.VossIntegration.ApiTools.Enums;
namespace BokaMera.API.ServiceModel.Dtos
{
[ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)]
public partial class SearchVossCustomers
{
///<summary>
///Organization number to search for.
///</summary>
[ApiMember(Description="Organization number to search for.")]
public virtual string OrganizationNumber { get; set; }
///<summary>
///Voss customer number to search for.
///</summary>
[ApiMember(Description="Voss customer number to search for.")]
public virtual int? CustomerNumber { get; set; }
///<summary>
///External id to search for.
///</summary>
[ApiMember(Description="External id to search for.")]
public virtual string ExternalId { get; set; }
}
public partial class SearchVossCustomersResponse
{
public virtual int TotalCount { get; set; }
public virtual List<CustomerResult> Items { get; set; } = [];
}
}
namespace BokaMera.VossIntegration.ApiTools.Enums
{
public enum CountryCodeEnum
{
AD,
AE,
AF,
AG,
AI,
AL,
AM,
AO,
AQ,
AR,
AS,
AT,
AU,
AW,
AX,
AZ,
BA,
BB,
BD,
BE,
BF,
BG,
BH,
BI,
BJ,
BL,
BM,
BN,
BO,
BQ,
BR,
BS,
BT,
BV,
BW,
BY,
BZ,
CA,
CC,
CD,
CF,
CG,
CH,
CI,
CK,
CL,
CM,
CN,
CO,
CR,
CU,
CV,
CW,
CX,
CY,
CZ,
DE,
DJ,
DK,
DM,
DO,
DZ,
EC,
EE,
EG,
EH,
ER,
ES,
ET,
FI,
FJ,
FK,
FM,
FO,
FR,
GA,
GB,
GD,
GE,
GF,
GG,
GH,
GI,
GL,
GM,
GN,
GP,
GQ,
GR,
GS,
GT,
GU,
GW,
GY,
HK,
HM,
HN,
HR,
HT,
HU,
ID,
IE,
IL,
IM,
IN,
IO,
IQ,
IR,
IS,
IT,
JE,
JM,
JO,
JP,
KE,
KG,
KH,
KI,
KM,
KN,
KP,
KR,
KW,
KY,
KZ,
LA,
LB,
LC,
LI,
LK,
LR,
LS,
LT,
LU,
LV,
LY,
MA,
MC,
MD,
ME,
MF,
MG,
MH,
MK,
ML,
MM,
MN,
MO,
MP,
MQ,
MR,
MS,
MT,
MU,
MV,
MW,
MX,
MY,
MZ,
NA,
NC,
NE,
NF,
NG,
NI,
NL,
NO,
NP,
NR,
NU,
NZ,
OM,
PA,
PE,
PF,
PG,
PH,
PK,
PL,
PM,
PN,
PR,
PS,
PT,
PW,
PY,
QA,
RE,
RO,
RS,
RU,
RW,
SA,
SB,
SC,
SD,
SE,
SG,
SH,
SI,
SJ,
SK,
SL,
SM,
SN,
SO,
SR,
SS,
ST,
SV,
SX,
SY,
SZ,
TC,
TD,
TF,
TG,
TH,
TJ,
TK,
TL,
TM,
TN,
TO,
TR,
TT,
TV,
TW,
TZ,
UA,
UG,
UM,
US,
UY,
UZ,
VA,
VC,
VE,
VG,
VI,
VN,
VU,
WF,
WS,
YE,
YT,
ZA,
ZM,
ZW,
}
}
namespace BokaMera.VossIntegration.ApiTools.Model
{
[DataContract(Name="CustomerContactPersonDto")]
public partial class CustomerContactPersonDto
{
[DataMember(Name="email", IsRequired=true)]
public virtual string Email { get; set; }
[DataMember(Name="firstName", IsRequired=true)]
public virtual string FirstName { get; set; }
[DataMember(Name="lastName", IsRequired=true)]
public virtual string LastName { get; set; }
[DataMember(Name="phoneNumber")]
public virtual string PhoneNumber { get; set; }
}
[DataContract(Name="CustomerResult")]
public partial class CustomerResult
{
[DataMember(Name="countryCode")]
public virtual CountryCodeEnum? CountryCode { get; set; }
[DataMember(Name="id", IsRequired=true)]
public virtual Guid Id { get; set; }
[DataMember(Name="name", IsRequired=true)]
public virtual string Name { get; set; }
[DataMember(Name="customerNumber")]
public virtual int? CustomerNumber { get; set; }
[DataMember(Name="organizationNumber")]
public virtual string OrganizationNumber { get; set; }
[DataMember(Name="email")]
public virtual string Email { get; set; }
[DataMember(Name="careOf")]
public virtual string CareOf { get; set; }
[DataMember(Name="address")]
public virtual string Address { get; set; }
[DataMember(Name="postalCode")]
public virtual string PostalCode { get; set; }
[DataMember(Name="city")]
public virtual string City { get; set; }
[DataMember(Name="electronicInvoiceOperatorCode")]
public virtual string ElectronicInvoiceOperatorCode { get; set; }
[DataMember(Name="electronicInvoiceAddress")]
public virtual string ElectronicInvoiceAddress { get; set; }
[DataMember(Name="customerGroup")]
public virtual int? CustomerGroup { get; set; }
[DataMember(Name="contactPerson")]
public virtual CustomerContactPersonDto ContactPerson { get; set; }
[DataMember(Name="targetGroups", EmitDefaultValue=false)]
public virtual List<CustomerTargetGroupDto> TargetGroups { get; set; } = [];
[DataMember(Name="expiryDate")]
public virtual DateTime? ExpiryDate { get; set; }
[DataMember(Name="created", IsRequired=true)]
public virtual DateTime Created { get; set; }
[DataMember(Name="externalId")]
public virtual string ExternalId { get; set; }
}
[DataContract(Name="CustomerTargetGroupDto")]
public partial class CustomerTargetGroupDto
{
[DataMember(Name="id", IsRequired=true)]
public virtual Guid Id { get; set; }
[DataMember(Name="name", IsRequired=true)]
public virtual string Name { get; set; }
[DataMember(Name="isDefault")]
public virtual bool IsDefault { get; set; }
[DataMember(Name="externalId")]
public virtual string ExternalId { get; set; }
}
}
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 /voss/customers HTTP/1.1 Host: testapi.bokamera.se Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<SearchVossCustomersResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<Items xmlns:d2p1="http://schemas.datacontract.org/2004/07/BokaMera.VossIntegration.ApiTools.Model">
<d2p1:CustomerResult i:nil="true" />
</Items>
<TotalCount>0</TotalCount>
</SearchVossCustomersResponse>