BokaMera.API.Host

<back to all web services

GetVossProducts

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

namespace BokaMera.API.ServiceModel.Dtos
{
    [ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)]
    public partial class GetVossProducts
        : 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 virtual Guid? CompanyId { get; set; }
    }

}

namespace VossIntegration.ApiTools.Model
{
    [DataContract(Name="ProductResult")]
    public partial class ProductResult
    {
        [DataMember(Name="type", IsRequired=true)]
        public virtual TypeEnum Type { get; set; }

        [DataMember(Name="status", IsRequired=true)]
        public virtual StatusEnum Status { get; set; }

        [DataMember(Name="id", IsRequired=true)]
        public virtual Guid Id { get; set; }

        [DataMember(Name="name", IsRequired=true)]
        public virtual string Name { get; set; }

        [DataMember(Name="externalId")]
        public virtual string ExternalId { get; set; }

        [DataMember(Name="articleNumber", IsRequired=true)]
        public virtual string ArticleNumber { get; set; }

        [DataMember(Name="productFamily", IsRequired=true)]
        public virtual ProductResultProductFamilyDto ProductFamily { get; set; }
        public enum TypeEnum
        {
            Main = 1,
            Addon = 2,
            License = 3,
            Usage = 4,
        }

        public enum StatusEnum
        {
            Published = 1,
            Disabled = 2,
        }

    }

    [DataContract(Name="ProductResultProductFamilyDto")]
    public partial class ProductResultProductFamilyDto
    {
        [DataMember(Name="id", IsRequired=true)]
        public virtual Guid Id { get; set; }

        [DataMember(Name="externalId")]
        public virtual string ExternalId { get; set; }
    }

    [DataContract(Name="SearchProductsResult")]
    public partial class SearchProductsResult
    {
        public SearchProductsResult()
        {
            Items = new List<ProductResult>{};
        }

        [DataMember(Name="items", EmitDefaultValue=false)]
        public virtual List<ProductResult> Items { get; set; }

        [DataMember(Name="totalCount", EmitDefaultValue=false)]
        public virtual int TotalCount { get; set; }

        [DataMember(Name="pageIndex", EmitDefaultValue=false)]
        public virtual int PageIndex { get; set; }

        [DataMember(Name="pageSize", EmitDefaultValue=false)]
        public virtual int PageSize { get; set; }

        [DataMember(Name="totalPages", EmitDefaultValue=false)]
        public virtual int TotalPages { get; set; }
    }

}

C# GetVossProducts 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/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>