| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| GET | /voss/targetGroups | Get all Voss target groups | Returns every target group in the Voss tenant (all pages). |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TotalCount | form | int | No | |
| Items | form | List<TargetGroupResult> | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | Guid | No | |
| Name | form | string | Yes | |
| IsDefault | form | bool | No | |
| ExternalId | form | string | Yes | |
| VarConfiguration | form | TargetGroupConfigurationResult | Yes | |
| Tags | form | List<TargetGroupTagDto> | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | Guid | No | |
| OrganizationNumberRequired | form | bool | No | |
| OrganizationNumberUnique | form | bool | No | |
| CustomerNumberRequired | form | bool | No | |
| CustomerAddressRequired | form | bool | No | |
| ContactPersonRequired | form | bool | No | |
| ExpiryDateRequired | form | bool | No | |
| ExcludeCustomerFromInvoiceFile | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Type | form | TypeEnum | No | |
| Tag | form | string | Yes |
| Exclusivity |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>