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.*;

public class dtos
{

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

    public static class GetVossTargetGroupsResponse
    {
        public Integer TotalCount = null;
        public ArrayList<TargetGroupResult> Items = new ArrayList<TargetGroupResult>();
        
        public Integer getTotalCount() { return TotalCount; }
        public GetVossTargetGroupsResponse setTotalCount(Integer value) { this.TotalCount = value; return this; }
        public ArrayList<TargetGroupResult> getItems() { return Items; }
        public GetVossTargetGroupsResponse setItems(ArrayList<TargetGroupResult> value) { this.Items = value; return this; }
    }

    @DataContract(Name="TargetGroupResult")
    public static class TargetGroupResult
    {
        @DataMember(Name="id", IsRequired=true)
        @SerializedName("id")
        public UUID Id = null;

        @DataMember(Name="name", IsRequired=true)
        @SerializedName("name")
        public String Name = null;

        @DataMember(Name="isDefault")
        @SerializedName("isDefault")
        public Boolean IsDefault = null;

        @DataMember(Name="externalId")
        @SerializedName("externalId")
        public String ExternalId = null;

        @DataMember(Name="configuration", EmitDefaultValue=false)
        @SerializedName("configuration")
        public TargetGroupConfigurationResult VarConfiguration = null;

        @DataMember(Name="tags", EmitDefaultValue=false)
        @SerializedName("tags")
        public ArrayList<TargetGroupTagDto> Tags = new ArrayList<TargetGroupTagDto>();
        
        public UUID getId() { return Id; }
        public TargetGroupResult setId(UUID value) { this.Id = value; return this; }
        public String getName() { return Name; }
        public TargetGroupResult setName(String value) { this.Name = value; return this; }
        public Boolean getIsDefault() { return IsDefault; }
        public TargetGroupResult setIsDefault(Boolean value) { this.IsDefault = value; return this; }
        public String getExternalId() { return ExternalId; }
        public TargetGroupResult setExternalId(String value) { this.ExternalId = value; return this; }
        public TargetGroupConfigurationResult getVarConfiguration() { return VarConfiguration; }
        public TargetGroupResult setVarConfiguration(TargetGroupConfigurationResult value) { this.VarConfiguration = value; return this; }
        public ArrayList<TargetGroupTagDto> getTags() { return Tags; }
        public TargetGroupResult setTags(ArrayList<TargetGroupTagDto> value) { this.Tags = value; return this; }
    }

    @DataContract(Name="TargetGroupConfigurationResult")
    public static class TargetGroupConfigurationResult
    {
        @DataMember(Name="id", IsRequired=true)
        @SerializedName("id")
        public UUID Id = null;

        @DataMember(Name="organizationNumberRequired")
        @SerializedName("organizationNumberRequired")
        public Boolean OrganizationNumberRequired = null;

        @DataMember(Name="organizationNumberUnique")
        @SerializedName("organizationNumberUnique")
        public Boolean OrganizationNumberUnique = null;

        @DataMember(Name="customerNumberRequired")
        @SerializedName("customerNumberRequired")
        public Boolean CustomerNumberRequired = null;

        @DataMember(Name="customerAddressRequired")
        @SerializedName("customerAddressRequired")
        public Boolean CustomerAddressRequired = null;

        @DataMember(Name="contactPersonRequired")
        @SerializedName("contactPersonRequired")
        public Boolean ContactPersonRequired = null;

        @DataMember(Name="expiryDateRequired")
        @SerializedName("expiryDateRequired")
        public Boolean ExpiryDateRequired = null;

        @DataMember(Name="excludeCustomerFromInvoiceFile")
        @SerializedName("excludeCustomerFromInvoiceFile")
        public Boolean ExcludeCustomerFromInvoiceFile = null;
        
        public UUID getId() { return Id; }
        public TargetGroupConfigurationResult setId(UUID value) { this.Id = value; return this; }
        public Boolean isOrganizationNumberRequired() { return OrganizationNumberRequired; }
        public TargetGroupConfigurationResult setOrganizationNumberRequired(Boolean value) { this.OrganizationNumberRequired = value; return this; }
        public Boolean isOrganizationNumberUnique() { return OrganizationNumberUnique; }
        public TargetGroupConfigurationResult setOrganizationNumberUnique(Boolean value) { this.OrganizationNumberUnique = value; return this; }
        public Boolean isCustomerNumberRequired() { return CustomerNumberRequired; }
        public TargetGroupConfigurationResult setCustomerNumberRequired(Boolean value) { this.CustomerNumberRequired = value; return this; }
        public Boolean isCustomerAddressRequired() { return CustomerAddressRequired; }
        public TargetGroupConfigurationResult setCustomerAddressRequired(Boolean value) { this.CustomerAddressRequired = value; return this; }
        public Boolean isContactPersonRequired() { return ContactPersonRequired; }
        public TargetGroupConfigurationResult setContactPersonRequired(Boolean value) { this.ContactPersonRequired = value; return this; }
        public Boolean isExpiryDateRequired() { return ExpiryDateRequired; }
        public TargetGroupConfigurationResult setExpiryDateRequired(Boolean value) { this.ExpiryDateRequired = value; return this; }
        public Boolean isExcludeCustomerFromInvoiceFile() { return ExcludeCustomerFromInvoiceFile; }
        public TargetGroupConfigurationResult setExcludeCustomerFromInvoiceFile(Boolean value) { this.ExcludeCustomerFromInvoiceFile = value; return this; }
    }

    @DataContract(Name="TargetGroupTagDto")
    public static class TargetGroupTagDto
    {
        @DataMember(Name="type", IsRequired=true)
        @SerializedName("type")
        public TypeEnum Type = null;

        @DataMember(Name="tag", IsRequired=true)
        @SerializedName("tag")
        public String Tag = null;
        
        public TypeEnum getType() { return Type; }
        public TargetGroupTagDto setType(TypeEnum value) { this.Type = value; return this; }
        public String getTag() { return Tag; }
        public TargetGroupTagDto setTag(String value) { this.Tag = value; return this; }
    }

    public static enum TypeEnum
    {
        Exclusivity;
    }

}

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