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).
namespace BokaMera.API.ServiceModel.Dtos

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<DataContract(Name="TargetGroupConfigurationResult")>]
    [<AllowNullLiteral>]
    type TargetGroupConfigurationResult() = 
        [<DataMember(Name="id", IsRequired=true)>]
        member val Id:Guid = new Guid() with get,set

        [<DataMember(Name="organizationNumberRequired")>]
        member val OrganizationNumberRequired:Boolean = new Boolean() with get,set

        [<DataMember(Name="organizationNumberUnique")>]
        member val OrganizationNumberUnique:Boolean = new Boolean() with get,set

        [<DataMember(Name="customerNumberRequired")>]
        member val CustomerNumberRequired:Boolean = new Boolean() with get,set

        [<DataMember(Name="customerAddressRequired")>]
        member val CustomerAddressRequired:Boolean = new Boolean() with get,set

        [<DataMember(Name="contactPersonRequired")>]
        member val ContactPersonRequired:Boolean = new Boolean() with get,set

        [<DataMember(Name="expiryDateRequired")>]
        member val ExpiryDateRequired:Boolean = new Boolean() with get,set

        [<DataMember(Name="excludeCustomerFromInvoiceFile")>]
        member val ExcludeCustomerFromInvoiceFile:Boolean = new Boolean() with get,set

    type TypeEnum =
        | Exclusivity = 0

    [<DataContract(Name="TargetGroupTagDto")>]
    [<AllowNullLiteral>]
    type TargetGroupTagDto() = 
        [<DataMember(Name="type", IsRequired=true)>]
        member val Type:TypeEnum = new TypeEnum() with get,set

        [<DataMember(Name="tag", IsRequired=true)>]
        member val Tag:String = null with get,set

    [<DataContract(Name="TargetGroupResult")>]
    [<AllowNullLiteral>]
    type TargetGroupResult() = 
        [<DataMember(Name="id", IsRequired=true)>]
        member val Id:Guid = new Guid() with get,set

        [<DataMember(Name="name", IsRequired=true)>]
        member val Name:String = null with get,set

        [<DataMember(Name="isDefault")>]
        member val IsDefault:Boolean = new Boolean() with get,set

        [<DataMember(Name="externalId")>]
        member val ExternalId:String = null with get,set

        [<DataMember(Name="configuration", EmitDefaultValue=false)>]
        member val VarConfiguration:TargetGroupConfigurationResult = null with get,set

        [<DataMember(Name="tags", EmitDefaultValue=false)>]
        member val Tags:ResizeArray<TargetGroupTagDto> = null with get,set

    [<AllowNullLiteral>]
    type GetVossTargetGroupsResponse() = 
        member val TotalCount:Int32 = new Int32() with get,set
        member val Items:ResizeArray<TargetGroupResult> = null with get,set

    [<ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)>]
    [<AllowNullLiteral>]
    type GetVossTargetGroups() = 
        class end

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