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

"use strict";
export class TargetGroupConfigurationResult {
    /** @param {{id?:string,organizationNumberRequired?:boolean,organizationNumberUnique?:boolean,customerNumberRequired?:boolean,customerAddressRequired?:boolean,contactPersonRequired?:boolean,expiryDateRequired?:boolean,excludeCustomerFromInvoiceFile?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    id;
    /** @type {boolean} */
    organizationNumberRequired;
    /** @type {boolean} */
    organizationNumberUnique;
    /** @type {boolean} */
    customerNumberRequired;
    /** @type {boolean} */
    customerAddressRequired;
    /** @type {boolean} */
    contactPersonRequired;
    /** @type {boolean} */
    expiryDateRequired;
    /** @type {boolean} */
    excludeCustomerFromInvoiceFile;
}
/** @typedef {'Exclusivity'} */
export var TypeEnum;
(function (TypeEnum) {
    TypeEnum["Exclusivity"] = "Exclusivity"
})(TypeEnum || (TypeEnum = {}));
export class TargetGroupTagDto {
    /** @param {{type?:TypeEnum,tag?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {TypeEnum} */
    type;
    /** @type {string} */
    tag;
}
export class TargetGroupResult {
    /** @param {{id?:string,name?:string,isDefault?:boolean,externalId?:string,configuration?:TargetGroupConfigurationResult,tags?:TargetGroupTagDto[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    id;
    /** @type {string} */
    name;
    /** @type {boolean} */
    isDefault;
    /** @type {string} */
    externalId;
    /** @type {TargetGroupConfigurationResult} */
    configuration;
    /** @type {TargetGroupTagDto[]} */
    tags = [];
}
export class GetVossTargetGroupsResponse {
    /** @param {{TotalCount?:number,Items?:TargetGroupResult[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    TotalCount;
    /** @type {TargetGroupResult[]} */
    Items = [];
}
export class GetVossTargetGroups {
    constructor(init) { Object.assign(this, init) }
}

JavaScript GetVossTargetGroups DTOs

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>