Hmx Accounts

<back to all web services

GetProducts

Requires Authentication
The following routes are available for this service:
GET/api/productsSearch for Products
import 'package:servicestack/servicestack.dart';

class ProductDto implements IConvertible
{
    String? id;
    String? name;
    String? description;
    String? longDescription;
    String? details;
    double? price;
    String? productType;
    int? year;
    String? applicationId;
    String? requiredProductId;
    String? scope;
    String? feature;
    bool? isVisible;
    String? iconUrl;
    Map<int,double?>? volumeDiscounts;

    ProductDto({this.id,this.name,this.description,this.longDescription,this.details,this.price,this.productType,this.year,this.applicationId,this.requiredProductId,this.scope,this.feature,this.isVisible,this.iconUrl,this.volumeDiscounts});
    ProductDto.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        id = json['id'];
        name = json['name'];
        description = json['description'];
        longDescription = json['longDescription'];
        details = json['details'];
        price = JsonConverters.toDouble(json['price']);
        productType = json['productType'];
        year = json['year'];
        applicationId = json['applicationId'];
        requiredProductId = json['requiredProductId'];
        scope = json['scope'];
        feature = json['feature'];
        isVisible = json['isVisible'];
        iconUrl = json['iconUrl'];
        volumeDiscounts = JsonConverters.fromJson(json['volumeDiscounts'],'Map<int,double?>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'id': id,
        'name': name,
        'description': description,
        'longDescription': longDescription,
        'details': details,
        'price': price,
        'productType': productType,
        'year': year,
        'applicationId': applicationId,
        'requiredProductId': requiredProductId,
        'scope': scope,
        'feature': feature,
        'isVisible': isVisible,
        'iconUrl': iconUrl,
        'volumeDiscounts': JsonConverters.toJson(volumeDiscounts,'Map<int,double?>',context!)
    };

    getTypeName() => "ProductDto";
    TypeContext? context = _ctx;
}

class GetProductsResponse implements IConvertible
{
    List<ProductDto>? results;

    GetProductsResponse({this.results});
    GetProductsResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        results = JsonConverters.fromJson(json['results'],'List<ProductDto>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'results': JsonConverters.toJson(results,'List<ProductDto>',context!)
    };

    getTypeName() => "GetProductsResponse";
    TypeContext? context = _ctx;
}

class GetProducts implements IConvertible
{
    String? applicationId;
    String? feature;
    String? scope;
    String? name;
    String? productType;
    int? year;
    String? requiredProductId;
    bool? isVisible;

    GetProducts({this.applicationId,this.feature,this.scope,this.name,this.productType,this.year,this.requiredProductId,this.isVisible});
    GetProducts.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        applicationId = json['applicationId'];
        feature = json['feature'];
        scope = json['scope'];
        name = json['name'];
        productType = json['productType'];
        year = json['year'];
        requiredProductId = json['requiredProductId'];
        isVisible = json['isVisible'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'applicationId': applicationId,
        'feature': feature,
        'scope': scope,
        'name': name,
        'productType': productType,
        'year': year,
        'requiredProductId': requiredProductId,
        'isVisible': isVisible
    };

    getTypeName() => "GetProducts";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'accounts.dev.healthmonix.com', types: <String, TypeInfo> {
    'ProductDto': TypeInfo(TypeOf.Class, create:() => ProductDto()),
    'Map<int,double?>': TypeInfo(TypeOf.Class, create:() => Map<int,double?>()),
    'GetProductsResponse': TypeInfo(TypeOf.Class, create:() => GetProductsResponse()),
    'List<ProductDto>': TypeInfo(TypeOf.Class, create:() => <ProductDto>[]),
    'GetProducts': TypeInfo(TypeOf.Class, create:() => GetProducts()),
});

Dart 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>