BokaMera.API.Host

<back to all web services

GetVossProducts

The following routes are available for this service:
GET/voss/productsgets voss products
namespace BokaMera.API.ServiceModel.Dtos

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    type TypeEnum =
        | Main = 1
        | Addon = 2
        | License = 3
        | Usage = 4

    type StatusEnum =
        | Published = 1
        | Disabled = 2

    [<DataContract(Name="ProductResultProductFamilyDto")>]
    [<AllowNullLiteral>]
    type ProductResultProductFamilyDto() = 
        [<DataMember(Name="id", IsRequired=true)>]
        member val Id:Guid = new Guid() with get,set

        [<DataMember(Name="externalId")>]
        member val ExternalId:String = null with get,set

    [<DataContract(Name="ProductResult")>]
    [<AllowNullLiteral>]
    type ProductResult() = 
        [<DataMember(Name="type", IsRequired=true)>]
        member val Type:TypeEnum = new TypeEnum() with get,set

        [<DataMember(Name="status", IsRequired=true)>]
        member val Status:StatusEnum = new StatusEnum() with get,set

        [<DataMember(Name="id", IsRequired=true)>]
        member val Id:Guid = new Guid() with get,set

        [<DataMember(Name="name", IsRequired=true)>]
        member val Name:String = null with get,set

        [<DataMember(Name="externalId")>]
        member val ExternalId:String = null with get,set

        [<DataMember(Name="articleNumber", IsRequired=true)>]
        member val ArticleNumber:String = null with get,set

        [<DataMember(Name="productFamily", IsRequired=true)>]
        member val ProductFamily:ProductResultProductFamilyDto = null with get,set

    [<DataContract(Name="SearchProductsResult")>]
    [<AllowNullLiteral>]
    type SearchProductsResult() = 
        [<DataMember(Name="items", EmitDefaultValue=false)>]
        member val Items:ResizeArray<ProductResult> = new ResizeArray<ProductResult>() with get,set

        [<DataMember(Name="totalCount", EmitDefaultValue=false)>]
        member val TotalCount:Int32 = new Int32() with get,set

        [<DataMember(Name="pageIndex", EmitDefaultValue=false)>]
        member val PageIndex:Int32 = new Int32() with get,set

        [<DataMember(Name="pageSize", EmitDefaultValue=false)>]
        member val PageSize:Int32 = new Int32() with get,set

        [<DataMember(Name="totalPages", EmitDefaultValue=false)>]
        member val TotalPages:Int32 = new Int32() with get,set

    [<ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)>]
    [<AllowNullLiteral>]
    type GetVossProducts() = 
        ///<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.")>]
        member val CompanyId:Nullable<Guid> = new Nullable<Guid>() with get,set

F# 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>