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

<GetVossTargetGroupsResponse 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:TargetGroupResult i:nil="true" />
  </Items>
  <TotalCount>0</TotalCount>
</GetVossTargetGroupsResponse>