GetHotSpotsByDiagram

Request (GetHotSpotsByDiagram_IDSoapIn)

The request body is of type GetHotSpotsByDiagram_ID.

Request Body Parameters

Name	Description	Data Type
Diagram_ID		xml:int

Example

The following example shows how to perform the web operation in CyberStore.

Javascript

// Example: Get all Hot Spot data
//      for the Diagram with Diagram_ID = 2
// then send the response to the browser console

MakeAJAXCall("Inventory.GetHotSpotsByDiagram_ID", {
    Diagram_ID: 2
}, console.log);

200 Response (GetHotSpotsByDiagram_IDSoapOut)

The response body is of type GetHotSpotsByDiagram_IDResponse.

Response Body Parameters

Name	Description	Data Type
GetHotSpotsByDiagram_IDResult	A string value containing a JSON object. [ { "HotSpot_ID": 13, "XCoords": 529, "YCoords": 145, "Description": "", "Reference": "20", "RequiredQuantity": 1, "Item_ID": 623, "StockCode": "B114", "Name": "Radially Spoked Front Wheel", "LongDescription2": "Sub Assembly", "Headline": "", "SubHeadline": "", "ShortDescription": "Radially Spoked Front Wheel", "SortOrder": 2, "Unique_ID": "hotSpot_H13_I623" }, { "HotSpot_ID": 14, "XCoords": 474, "YCoords": 14, "Description": "", "Reference": "1", "RequiredQuantity": 1, "Item_ID": 622, "StockCode": "B113", "Name": "Handle Bar Assembly", "LongDescription2": "Sub Assembly", "Headline": "", "SubHeadline": "", "ShortDescription": "Handle Bar Assembly", "SortOrder": 4, "Unique_ID": "hotSpot_H14_I622" }, { "HotSpot_ID": 15, "XCoords": 146, "YCoords": 44, "Description": "", "Reference": "30", "RequiredQuantity": 2, "Item_ID": 623, "StockCode": "B114", "Name": "Radially Spoked Front Wheel", "LongDescription2": "Sub Assembly", "Headline": "", "SubHeadline": "", "ShortDescription": "Radially Spoked Front Wheel", "SortOrder": 6, "Unique_ID": "hotSpot_H15_I623" } ]	xml:string

Name

Description

Data Type

GetHotSpotsByDiagram_IDResult

A string value containing a JSON object.

[
    {
        "HotSpot_ID": 13,
        "XCoords": 529,
        "YCoords": 145,
        "Description": "",
        "Reference": "20",
        "RequiredQuantity": 1,
        "Item_ID": 623,
        "StockCode": "B114",
        "Name": "Radially Spoked Front Wheel",
        "LongDescription2": "Sub Assembly",
        "Headline": "",
        "SubHeadline": "",
        "ShortDescription": "Radially Spoked Front Wheel",
        "SortOrder": 2,
        "Unique_ID": "hotSpot_H13_I623"
    },
    {
        "HotSpot_ID": 14,
        "XCoords": 474,
        "YCoords": 14,
        "Description": "",
        "Reference": "1",
        "RequiredQuantity": 1,
        "Item_ID": 622,
        "StockCode": "B113",
        "Name": "Handle Bar Assembly",
        "LongDescription2": "Sub Assembly",
        "Headline": "",
        "SubHeadline": "",
        "ShortDescription": "Handle Bar Assembly",
        "SortOrder": 4,
        "Unique_ID": "hotSpot_H14_I622"
    },
    {
        "HotSpot_ID": 15,
        "XCoords": 146,
        "YCoords": 44,
        "Description": "",
        "Reference": "30",
        "RequiredQuantity": 2,
        "Item_ID": 623,
        "StockCode": "B114",
        "Name": "Radially Spoked Front Wheel",
        "LongDescription2": "Sub Assembly",
        "Headline": "",
        "SubHeadline": "",
        "ShortDescription": "Radially Spoked Front Wheel",
        "SortOrder": 6,
        "Unique_ID": "hotSpot_H15_I623"
    }
]

xml:string