Hmx Accounts

<back to all web services

GetProduct

Requires Authentication
The following routes are available for this service:
GET/api/products/{id}Get Product by Key
GetProduct Parameters:
NameParameterData TypeRequiredDescription
IdpathstringNo
ProductDto Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
NameformstringNo
DescriptionformstringNo
LongDescriptionformstringNo
DetailsformstringNo
PriceformdecimalNo
ProductTypeformstringNo
Yearformint?No
ApplicationIdformstringNo
RequiredProductIdformstringNo
ScopeformstringNo
FeatureformstringNo
IsVisibleformboolNo
IconUrlformstringNo
VolumeDiscountsformDictionary<int, decimal>No

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/{id} HTTP/1.1 
Host: accounts.dev.healthmonix.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ProductDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Hmx.Products.ServiceModel">
  <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:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfintdecimal>
      <d2p1:Key>0</d2p1:Key>
      <d2p1:Value>0</d2p1:Value>
    </d2p1:KeyValueOfintdecimal>
  </VolumeDiscounts>
  <Year>0</Year>
</ProductDto>