Hmx Accounts

<back to all web services

GetProducts

Requires Authentication
The following routes are available for this service:
GET/api/productsSearch for Products
import Foundation
import ServiceStack

public class GetProducts : Codable
{
    public var applicationId:String?
    public var feature:String?
    public var scope:String?
    public var name:String?
    public var productType:String?
    public var year:Int?
    public var requiredProductId:String?
    public var isVisible:Bool?

    required public init(){}
}

public class GetProductsResponse : Codable
{
    public var results:[ProductDto] = []

    required public init(){}
}

public class ProductDto : Codable
{
    public var id:String?
    public var name:String?
    public var Description:String?
    public var longDescription:String?
    public var details:String?
    public var price:Double?
    public var productType:String?
    public var year:Int?
    public var applicationId:String?
    public var requiredProductId:String?
    public var scope:String?
    public var feature:String?
    public var isVisible:Bool?
    public var iconUrl:String?
    public var volumeDiscounts:[Int:Double] = [:]

    required public init(){}
}


Swift GetProducts DTOs

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

HTTP + JSV

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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	results: 
	[
		{
			id: String,
			name: String,
			description: String,
			longDescription: String,
			details: String,
			price: 0,
			productType: String,
			year: 0,
			applicationId: String,
			requiredProductId: String,
			scope: String,
			feature: String,
			isVisible: False,
			iconUrl: String,
			volumeDiscounts: 
			{
				0: 0
			}
		}
	]
}