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).

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


@ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
open class GetVossTargetGroups
{
}

open class GetVossTargetGroupsResponse
{
    open var TotalCount:Int? = null
    open var Items:ArrayList<TargetGroupResult> = ArrayList<TargetGroupResult>()
}

@DataContract(Name="TargetGroupResult")
open class TargetGroupResult
{
    @DataMember(Name="id", IsRequired=true)
    @SerializedName("id")
    open var Id:UUID? = null

    @DataMember(Name="name", IsRequired=true)
    @SerializedName("name")
    open var Name:String? = null

    @DataMember(Name="isDefault")
    @SerializedName("isDefault")
    open var IsDefault:Boolean? = null

    @DataMember(Name="externalId")
    @SerializedName("externalId")
    open var ExternalId:String? = null

    @DataMember(Name="configuration", EmitDefaultValue=false)
    @SerializedName("configuration")
    open var VarConfiguration:TargetGroupConfigurationResult? = null

    @DataMember(Name="tags", EmitDefaultValue=false)
    @SerializedName("tags")
    open var Tags:ArrayList<TargetGroupTagDto> = ArrayList<TargetGroupTagDto>()
}

@DataContract(Name="TargetGroupConfigurationResult")
open class TargetGroupConfigurationResult
{
    @DataMember(Name="id", IsRequired=true)
    @SerializedName("id")
    open var Id:UUID? = null

    @DataMember(Name="organizationNumberRequired")
    @SerializedName("organizationNumberRequired")
    open var OrganizationNumberRequired:Boolean? = null

    @DataMember(Name="organizationNumberUnique")
    @SerializedName("organizationNumberUnique")
    open var OrganizationNumberUnique:Boolean? = null

    @DataMember(Name="customerNumberRequired")
    @SerializedName("customerNumberRequired")
    open var CustomerNumberRequired:Boolean? = null

    @DataMember(Name="customerAddressRequired")
    @SerializedName("customerAddressRequired")
    open var CustomerAddressRequired:Boolean? = null

    @DataMember(Name="contactPersonRequired")
    @SerializedName("contactPersonRequired")
    open var ContactPersonRequired:Boolean? = null

    @DataMember(Name="expiryDateRequired")
    @SerializedName("expiryDateRequired")
    open var ExpiryDateRequired:Boolean? = null

    @DataMember(Name="excludeCustomerFromInvoiceFile")
    @SerializedName("excludeCustomerFromInvoiceFile")
    open var ExcludeCustomerFromInvoiceFile:Boolean? = null
}

@DataContract(Name="TargetGroupTagDto")
open class TargetGroupTagDto
{
    @DataMember(Name="type", IsRequired=true)
    @SerializedName("type")
    open var Type:TypeEnum? = null

    @DataMember(Name="tag", IsRequired=true)
    @SerializedName("tag")
    open var Tag:String? = null
}

enum class TypeEnum
{
    Exclusivity,
}

Kotlin GetVossTargetGroups DTOs

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

HTTP + OTHER

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/jsonl

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

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