BokaMera.API.Host

<back to all web services

SearchVossCustomers

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
GET/voss/customersSearch voss customers by organization number, customer number or external idRaw passthrough to the Voss customer search. Returns all matching customers with their full fields (externalId, customerNumber, expiryDate, ...).
SearchVossCustomers Parameters:
NameParameterData TypeRequiredDescription
OrganizationNumberquerystringYesOrganization number to search for.
CustomerNumberqueryint?NoVoss customer number to search for.
ExternalIdquerystringYesExternal id to search for.
SearchVossCustomersResponse Parameters:
NameParameterData TypeRequiredDescription
TotalCountformintNo
ItemsformList<CustomerResult>Yes
CustomerResult Parameters:
NameParameterData TypeRequiredDescription
CountryCodeformCountryCodeEnum?No
IdformGuidNo
NameformstringYes
CustomerNumberformint?No
OrganizationNumberformstringYes
EmailformstringYes
CareOfformstringYes
AddressformstringYes
PostalCodeformstringYes
CityformstringYes
ElectronicInvoiceOperatorCodeformstringYes
ElectronicInvoiceAddressformstringYes
CustomerGroupformint?No
ContactPersonformCustomerContactPersonDtoYes
TargetGroupsformList<CustomerTargetGroupDto>Yes
ExpiryDateformDateTime?No
CreatedformDateTimeNo
ExternalIdformstringYes
CountryCodeEnum Enum:
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
CustomerContactPersonDto Parameters:
NameParameterData TypeRequiredDescription
EmailformstringYes
FirstNameformstringYes
LastNameformstringYes
PhoneNumberformstringYes
CustomerTargetGroupDto Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
NameformstringYes
IsDefaultformboolNo
ExternalIdformstringYes

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 /voss/customers HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"TotalCount":0,"Items":[{}]}