POST api/Lookups/GetIcons

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
District	string	None.
IncludeShapeGroupIcons	boolean	None.
IncludeMetalIcons	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "District": "sample string 1",
  "IncludeShapeGroupIcons": true,
  "IncludeMetalIcons": true
}

application/xml, text/xml

Sample:

<GetIconsByDistrictCommand xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Pronto.Core.Services.ServiceCommands">
  <District>sample string 1</District>
  <IncludeMetalIcons>true</IncludeMetalIcons>
  <IncludeShapeGroupIcons>true</IncludeShapeGroupIcons>
</GetIconsByDistrictCommand>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Icons

Name	Type	Additional information
DisplayConfiguration_ShapeGroupIcons	Collection of DisplayConfiguration_ShapeGroupIcon	None.
DisplayConfiguration_MetalIcons	Collection of DisplayConfiguration_MetalIcon	None.
DisplayConfiguration_ExcessIcons	Collection of DisplayConfiguration_ExcessIcon	None.

Response Formats

application/json, text/json

Sample:

{
  "DisplayConfiguration_ShapeGroupIcons": [
    {
      "ShapeGroupId": 1,
      "IconUrl": "sample string 2",
      "MobileIconUrl": "sample string 3",
      "AppIconUrl": "sample string 4",
      "Row": 5,
      "Column": 6,
      "ShapeGroupLabel": "sample string 7",
      "AvailableMetalIcons": [
        {
          "MetalId": 1,
          "IconUrl": "sample string 2",
          "MobileIconUrl": "sample string 3",
          "AppIconUrl": "sample string 4",
          "Row": 5,
          "Column": 6,
          "MetalLabel": "sample string 7",
          "AvailableShapeGroupIcons": []
        },
        {
          "MetalId": 1,
          "IconUrl": "sample string 2",
          "MobileIconUrl": "sample string 3",
          "AppIconUrl": "sample string 4",
          "Row": 5,
          "Column": 6,
          "MetalLabel": "sample string 7",
          "AvailableShapeGroupIcons": []
        }
      ]
    },
    {
      "ShapeGroupId": 1,
      "IconUrl": "sample string 2",
      "MobileIconUrl": "sample string 3",
      "AppIconUrl": "sample string 4",
      "Row": 5,
      "Column": 6,
      "ShapeGroupLabel": "sample string 7",
      "AvailableMetalIcons": [
        {
          "MetalId": 1,
          "IconUrl": "sample string 2",
          "MobileIconUrl": "sample string 3",
          "AppIconUrl": "sample string 4",
          "Row": 5,
          "Column": 6,
          "MetalLabel": "sample string 7",
          "AvailableShapeGroupIcons": []
        },
        {
          "MetalId": 1,
          "IconUrl": "sample string 2",
          "MobileIconUrl": "sample string 3",
          "AppIconUrl": "sample string 4",
          "Row": 5,
          "Column": 6,
          "MetalLabel": "sample string 7",
          "AvailableShapeGroupIcons": []
        }
      ]
    }
  ],
  "DisplayConfiguration_MetalIcons": [
    {
      "MetalId": 1,
      "IconUrl": "sample string 2",
      "MobileIconUrl": "sample string 3",
      "AppIconUrl": "sample string 4",
      "Row": 5,
      "Column": 6,
      "MetalLabel": "sample string 7",
      "AvailableShapeGroupIcons": [
        {
          "ShapeGroupId": 1,
          "IconUrl": "sample string 2",
          "MobileIconUrl": "sample string 3",
          "AppIconUrl": "sample string 4",
          "Row": 5,
          "Column": 6,
          "ShapeGroupLabel": "sample string 7",
          "AvailableMetalIcons": []
        },
        {
          "ShapeGroupId": 1,
          "IconUrl": "sample string 2",
          "MobileIconUrl": "sample string 3",
          "AppIconUrl": "sample string 4",
          "Row": 5,
          "Column": 6,
          "ShapeGroupLabel": "sample string 7",
          "AvailableMetalIcons": []
        }
      ]
    },
    {
      "MetalId": 1,
      "IconUrl": "sample string 2",
      "MobileIconUrl": "sample string 3",
      "AppIconUrl": "sample string 4",
      "Row": 5,
      "Column": 6,
      "MetalLabel": "sample string 7",
      "AvailableShapeGroupIcons": [
        {
          "ShapeGroupId": 1,
          "IconUrl": "sample string 2",
          "MobileIconUrl": "sample string 3",
          "AppIconUrl": "sample string 4",
          "Row": 5,
          "Column": 6,
          "ShapeGroupLabel": "sample string 7",
          "AvailableMetalIcons": []
        },
        {
          "ShapeGroupId": 1,
          "IconUrl": "sample string 2",
          "MobileIconUrl": "sample string 3",
          "AppIconUrl": "sample string 4",
          "Row": 5,
          "Column": 6,
          "ShapeGroupLabel": "sample string 7",
          "AvailableMetalIcons": []
        }
      ]
    }
  ],
  "DisplayConfiguration_ExcessIcons": [
    {
      "ExcessId": 1,
      "IconUrl": "sample string 2",
      "MobileIconUrl": "sample string 3",
      "AppIconUrl": "sample string 4",
      "Row": 5,
      "Column": 6
    },
    {
      "ExcessId": 1,
      "IconUrl": "sample string 2",
      "MobileIconUrl": "sample string 3",
      "AppIconUrl": "sample string 4",
      "Row": 5,
      "Column": 6
    }
  ]
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.