BokaMera.API.Host

<back to all web services

GetVossProducts

The following routes are available for this service:
GET/voss/productsgets voss products
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BokaMera.API.ServiceModel.Dtos
Imports VossIntegration.ApiTools.Enums

Namespace Global

    Namespace BokaMera.API.ServiceModel.Dtos

        <ApiResponse(Description:="You were unauthorized to call this service", StatusCode:=401)>
        Public Partial Class GetVossProducts
            '''<Summary>
            '''The type of the product  - Main = The product is treated as the main product of the product group (Only 1 allowed per product family in the package tier), billed in subscription billing period  - Addon = The product is treated as the addon product of the product group (Multiple allowed per product family in the package tier when Main product is also present),  billed in subscription billing period  - License = The product is treated as the license product in the product group (Multiple allowed per product family in the package tier when Main product is also present),  billed in subscription billing period and product quantity is carried over to the next billing period,  requires to have individual pricing in a product group pricing  - Usage = The product is treated as the usage product of the product group,  billed in usage billing period, the product quantity is reset every usage billing period,  requires to have individual pricing in a product group pricing
            '''</Summary>
            <ApiMember(Description:="The type of the product  - Main = The product is treated as the main product of the product group (Only 1 allowed per product family in the package tier), billed in subscription billing period  - Addon = The product is treated as the addon product of the product group (Multiple allowed per product family in the package tier when Main product is also present),  billed in subscription billing period  - License = The product is treated as the license product in the product group (Multiple allowed per product family in the package tier when Main product is also present),  billed in subscription billing period and product quantity is carried over to the next billing period,  requires to have individual pricing in a product group pricing  - Usage = The product is treated as the usage product of the product group,  billed in usage billing period, the product quantity is reset every usage billing period,  requires to have individual pricing in a product group pricing
")>
            Public Overridable Property ProductType As Nullable(Of ProductTypeEnum)
        End Class
    End Namespace

    Namespace VossIntegration.ApiTools.Enums

        Public Enum ProductTypeEnum
            Main
            Addon
            License
            Usage
        End Enum
    End Namespace
End Namespace

VB.NET GetVossProducts DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /voss/products HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

[{"Name":"String","ArticleNumber":"String"}]