NetCard Server Web API

<back to all web services

GetDeviceInventoryByCoil

The following routes are available for this service:
GET/DeviceInventory/GetDeviceInventoryByCoil

To override the Content-type in your clients 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.

POST /xml/reply/GetDeviceInventoryByCoil HTTP/1.1 
Host: ncapi.net.au 
Content-Type: application/xml
Content-Length: length

<GetDeviceInventoryByCoil xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NetCard.Server.API.ServiceModel.DeviceInventory">
  <Coil>String</Coil>
  <DeviceId>0</DeviceId>
</GetDeviceInventoryByCoil>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetDeviceInventoryByCoilResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NetCard.Server.API.ServiceModel.DeviceInventory">
  <ErrorCode xmlns="http://schemas.servicestack.net/types">String</ErrorCode>
  <Message xmlns="http://schemas.servicestack.net/types">String</Message>
  <StackTrace xmlns="http://schemas.servicestack.net/types">String</StackTrace>
  <Errors xmlns="http://schemas.servicestack.net/types">
    <ResponseError>
      <ErrorCode>String</ErrorCode>
      <FieldName>String</FieldName>
      <Message>String</Message>
    </ResponseError>
  </Errors>
  <DeviceInventory xmlns:d2p1="http://schemas.datacontract.org/2004/07/NetCard.Server.API.DTO">
    <d2p1:AccountCode>String</d2p1:AccountCode>
    <d2p1:DeviceId>0</d2p1:DeviceId>
    <d2p1:Inventory>
      <d2p1:Barcodes xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:Barcodes>
      <d2p1:Category>String</d2p1:Category>
      <d2p1:Coil>String</d2p1:Coil>
      <d2p1:CostBuyPrice>0</d2p1:CostBuyPrice>
      <d2p1:CustomerId>0</d2p1:CustomerId>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:Image>AA==</d2p1:Image>
      <d2p1:ImageVersion>0</d2p1:ImageVersion>
      <d2p1:InventoryId>0</d2p1:InventoryId>
      <d2p1:IsLow>false</d2p1:IsLow>
      <d2p1:LastChanged>0001-01-01T00:00:00</d2p1:LastChanged>
      <d2p1:Low>0</d2p1:Low>
      <d2p1:Max>0</d2p1:Max>
      <d2p1:Note>String</d2p1:Note>
      <d2p1:ParLevel>0</d2p1:ParLevel>
      <d2p1:PointsCost>0</d2p1:PointsCost>
      <d2p1:PointsRewarded>0</d2p1:PointsRewarded>
      <d2p1:Product>
        <d2p1:Cost>0</d2p1:Cost>
        <d2p1:CustomerId>0</d2p1:CustomerId>
        <d2p1:HealthFlag>
          <d2p1:Color>String</d2p1:Color>
          <d2p1:HealthFlagId>0</d2p1:HealthFlagId>
          <d2p1:Name>String</d2p1:Name>
        </d2p1:HealthFlag>
        <d2p1:HealthFlagId>0</d2p1:HealthFlagId>
        <d2p1:Healthy>false</d2p1:Healthy>
        <d2p1:IsAdvertise>false</d2p1:IsAdvertise>
        <d2p1:ManufacturerId>0</d2p1:ManufacturerId>
        <d2p1:Name>String</d2p1:Name>
        <d2p1:Note>String</d2p1:Note>
        <d2p1:PaidTax>0</d2p1:PaidTax>
        <d2p1:PicCode>String</d2p1:PicCode>
        <d2p1:ProductBarCodes i:nil="true" />
        <d2p1:ProductExtraOptions i:nil="true" />
        <d2p1:ProductId>0</d2p1:ProductId>
        <d2p1:ProductImage>String</d2p1:ProductImage>
        <d2p1:ProductProductCategories i:nil="true" />
        <d2p1:RecommendedSalePrice>0</d2p1:RecommendedSalePrice>
        <d2p1:ShortDescription>String</d2p1:ShortDescription>
        <d2p1:Size>String</d2p1:Size>
        <d2p1:StockCode>String</d2p1:StockCode>
        <d2p1:StockRestriction>String</d2p1:StockRestriction>
        <d2p1:SupplierId>0</d2p1:SupplierId>
        <d2p1:UnitCost>0</d2p1:UnitCost>
      </d2p1:Product>
      <d2p1:ProductCategoryId>0</d2p1:ProductCategoryId>
      <d2p1:ProductId>0</d2p1:ProductId>
      <d2p1:ProductTypeId>0</d2p1:ProductTypeId>
      <d2p1:Quantity>0</d2p1:Quantity>
      <d2p1:RawPrice>0</d2p1:RawPrice>
      <d2p1:SalePrice>0</d2p1:SalePrice>
      <d2p1:Taken>0</d2p1:Taken>
      <d2p1:Tax>0</d2p1:Tax>
      <d2p1:TaxPercent>0</d2p1:TaxPercent>
    </d2p1:Inventory>
    <d2p1:InventoryId>0</d2p1:InventoryId>
    <d2p1:IsAdvertise>false</d2p1:IsAdvertise>
  </DeviceInventory>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
      </d2p1:ResponseError>
    </d2p1:Errors>
  </ResponseStatus>
</GetDeviceInventoryByCoilResponse>