BokaMera.API.Host

<back to all web services

GetVossTargetGroups

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
GET/voss/targetGroupsGet all Voss target groupsReturns every target group in the Voss tenant (all pages).
GetVossTargetGroupsResponse Parameters:
NameParameterData TypeRequiredDescription
TotalCountformintNo
ItemsformList<TargetGroupResult>Yes
TargetGroupResult Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
NameformstringYes
IsDefaultformboolNo
ExternalIdformstringYes
VarConfigurationformTargetGroupConfigurationResultYes
TagsformList<TargetGroupTagDto>Yes
TargetGroupConfigurationResult Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
OrganizationNumberRequiredformboolNo
OrganizationNumberUniqueformboolNo
CustomerNumberRequiredformboolNo
CustomerAddressRequiredformboolNo
ContactPersonRequiredformboolNo
ExpiryDateRequiredformboolNo
ExcludeCustomerFromInvoiceFileformboolNo
TargetGroupTagDto Parameters:
NameParameterData TypeRequiredDescription
TypeformTypeEnumNo
TagformstringYes
TypeEnum Enum:
Exclusivity

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/targetGroups 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":[{}]}