BokaMera.API.Host

GetVossTargetGroups

**Requires Authentication**
Requires any of the roles:	bookingsupplier-administrator-write, superadmin

The following routes are available for this service:
GET	/voss/targetGroups	Get all Voss target groups	Returns every target group in the Voss tenant (all pages).

Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BokaMera.API.ServiceModel.Dtos
Imports BokaMera.VossIntegration.ApiTools.Model

Namespace Global

    Namespace BokaMera.API.ServiceModel.Dtos

        <ApiResponse(Description:="You were unauthorized to call this service", StatusCode:=401)>
        Public Partial Class GetVossTargetGroups
        End Class

        Public Partial Class GetVossTargetGroupsResponse
            Public Overridable Property TotalCount As Integer
            Public Overridable Property Items As List(Of TargetGroupResult) = New List(Of TargetGroupResult)
        End Class
    End Namespace

    Namespace BokaMera.VossIntegration.ApiTools.Model

        <DataContract(Name:="TargetGroupConfigurationResult")>
        Public Partial Class TargetGroupConfigurationResult
            <DataMember(Name:="id", IsRequired:=true)>
            Public Overridable Property Id As Guid

            <DataMember(Name:="organizationNumberRequired")>
            Public Overridable Property OrganizationNumberRequired As Boolean

            <DataMember(Name:="organizationNumberUnique")>
            Public Overridable Property OrganizationNumberUnique As Boolean

            <DataMember(Name:="customerNumberRequired")>
            Public Overridable Property CustomerNumberRequired As Boolean

            <DataMember(Name:="customerAddressRequired")>
            Public Overridable Property CustomerAddressRequired As Boolean

            <DataMember(Name:="contactPersonRequired")>
            Public Overridable Property ContactPersonRequired As Boolean

            <DataMember(Name:="expiryDateRequired")>
            Public Overridable Property ExpiryDateRequired As Boolean

            <DataMember(Name:="excludeCustomerFromInvoiceFile")>
            Public Overridable Property ExcludeCustomerFromInvoiceFile As Boolean
        End Class

        <DataContract(Name:="TargetGroupResult")>
        Public Partial Class TargetGroupResult
            <DataMember(Name:="id", IsRequired:=true)>
            Public Overridable Property Id As Guid

            <DataMember(Name:="name", IsRequired:=true)>
            Public Overridable Property Name As String

            <DataMember(Name:="isDefault")>
            Public Overridable Property IsDefault As Boolean

            <DataMember(Name:="externalId")>
            Public Overridable Property ExternalId As String

            <DataMember(Name:="configuration", EmitDefaultValue:=false)>
            Public Overridable Property VarConfiguration As TargetGroupConfigurationResult

            <DataMember(Name:="tags", EmitDefaultValue:=false)>
            Public Overridable Property Tags As List(Of TargetGroupTagDto) = New List(Of TargetGroupTagDto)
        End Class

        <DataContract(Name:="TargetGroupTagDto")>
        Public Partial Class TargetGroupTagDto
            <DataMember(Name:="type", IsRequired:=true)>
            Public Overridable Property Type As TypeEnum

            <DataMember(Name:="tag", IsRequired:=true)>
            Public Overridable Property Tag As String

            Public Enum TypeEnum
                Exclusivity
            End Enum
        End Class
    End Namespace
End Namespace

VB.NET GetVossTargetGroups DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

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