Hmx Accounts

<back to all web services

GetProducts

Requires Authentication
The following routes are available for this service:
GET/api/productsSearch for Products
namespace Hmx.Products.ServiceModel

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

    [<AllowNullLiteral>]
    type ProductDto() = 
        member val Id:String = null with get,set
        member val Name:String = null with get,set
        member val Description:String = null with get,set
        member val LongDescription:String = null with get,set
        member val Details:String = null with get,set
        member val Price:Decimal = new Decimal() with get,set
        member val ProductType:String = null with get,set
        member val Year:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val ApplicationId:String = null with get,set
        member val RequiredProductId:String = null with get,set
        member val Scope:String = null with get,set
        member val Feature:String = null with get,set
        member val IsVisible:Boolean = new Boolean() with get,set
        member val IconUrl:String = null with get,set
        member val VolumeDiscounts:Dictionary<Int32, Decimal> = new Dictionary<Int32, Decimal>() with get,set

    [<AllowNullLiteral>]
    type GetProductsResponse() = 
        member val Results:ResizeArray<ProductDto> = new ResizeArray<ProductDto>() with get,set

    [<AllowNullLiteral>]
    type GetProducts() = 
        member val ApplicationId:String = null with get,set
        member val Feature:String = null with get,set
        member val Scope:String = null with get,set
        member val Name:String = null with get,set
        member val ProductType:String = null with get,set
        member val Year:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val RequiredProductId:String = null with get,set
        member val IsVisible:Nullable<Boolean> = new Nullable<Boolean>() with get,set

F# GetProducts 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 /api/products HTTP/1.1 
Host: accounts.dev.healthmonix.com 
Accept: application/xml

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

<GetProductsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Hmx.Products.ServiceModel">
  <Results>
    <ProductDto>
      <ApplicationId>String</ApplicationId>
      <Description>String</Description>
      <Details>String</Details>
      <Feature>String</Feature>
      <IconUrl>String</IconUrl>
      <Id>String</Id>
      <IsVisible>false</IsVisible>
      <LongDescription>String</LongDescription>
      <Name>String</Name>
      <Price>0</Price>
      <ProductType>String</ProductType>
      <RequiredProductId>String</RequiredProductId>
      <Scope>String</Scope>
      <VolumeDiscounts xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfintdecimal>
          <d4p1:Key>0</d4p1:Key>
          <d4p1:Value>0</d4p1:Value>
        </d4p1:KeyValueOfintdecimal>
      </VolumeDiscounts>
      <Year>0</Year>
    </ProductDto>
  </Results>
</GetProductsResponse>