BokaMera.API.Host

<back to all web services

GetVossProducts

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

Namespace Global

    Namespace BokaMera.API.ServiceModel.Dtos

        <ApiResponse(Description:="You were unauthorized to call this service", StatusCode:=401)>
        Public Partial Class GetVossProducts
            Implements ICompany
            '''<Summary>
            '''The company id, if empty will use the company id for the user you are logged in with.
            '''</Summary>
            <ApiMember(Description:="The company id, if empty will use the company id for the user you are logged in with.")>
            Public Overridable Property CompanyId As Nullable(Of Guid)
        End Class
    End Namespace

    Namespace VossIntegration.ApiTools.Model

        <DataContract(Name:="ProductResult")>
        Public Partial Class ProductResult
            <DataMember(Name:="type", IsRequired:=true)>
            Public Overridable Property Type As TypeEnum

            <DataMember(Name:="status", IsRequired:=true)>
            Public Overridable Property Status As StatusEnum

            <DataMember(Name:="id", IsRequired:=true)>
            Public Overridable Property Id As Guid

            <DataMember(Name:="name", IsRequired:=true)>
            Public Overridable Property Name As String

            <DataMember(Name:="externalId")>
            Public Overridable Property ExternalId As String

            <DataMember(Name:="articleNumber", IsRequired:=true)>
            Public Overridable Property ArticleNumber As String

            <DataMember(Name:="productFamily", IsRequired:=true)>
            Public Overridable Property ProductFamily As ProductResultProductFamilyDto

            Public Enum TypeEnum
                Main = 1
                Addon = 2
                License = 3
                Usage = 4
            End Enum

            Public Enum StatusEnum
                Published = 1
                Disabled = 2
            End Enum
        End Class

        <DataContract(Name:="ProductResultProductFamilyDto")>
        Public Partial Class ProductResultProductFamilyDto
            <DataMember(Name:="id", IsRequired:=true)>
            Public Overridable Property Id As Guid

            <DataMember(Name:="externalId")>
            Public Overridable Property ExternalId As String
        End Class

        <DataContract(Name:="SearchProductsResult")>
        Public Partial Class SearchProductsResult
            Public Sub New()
                Items = New List(Of ProductResult)
            End Sub

            <DataMember(Name:="items", EmitDefaultValue:=false)>
            Public Overridable Property Items As List(Of ProductResult)

            <DataMember(Name:="totalCount", EmitDefaultValue:=false)>
            Public Overridable Property TotalCount As Integer

            <DataMember(Name:="pageIndex", EmitDefaultValue:=false)>
            Public Overridable Property PageIndex As Integer

            <DataMember(Name:="pageSize", EmitDefaultValue:=false)>
            Public Overridable Property PageSize As Integer

            <DataMember(Name:="totalPages", EmitDefaultValue:=false)>
            Public Overridable Property TotalPages As Integer
        End Class
    End Namespace
End Namespace

VB.NET GetVossProducts DTOs

GET /voss/products HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SearchProductsResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VossIntegration.ApiTools.Model">
  <items>
    <ProductResult i:nil="true" />
  </items>
</SearchProductsResult>