GET api/Communes?fullResult={fullResult}

Get Communes

Request Information

URI Parameters

Name	Description	Type	Additional information
fullResult	Full result of connected entities	FullResultEnum	Default value is Yes

Body Parameters

None.

Response Information

Resource Description

List of Communes, sorted by Commune Id

Collection of CommuneDto

Name	Description	Type	Additional information
CommuneId	Id (key) of Commune	integer	Required
Name	Commune Name	string	Required
ItemNumber	Commune Item Number	string	None.
Rules	Collection of Commune Rules	Collection of CommuneRuleDto	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "CommuneId": 1,
    "Name": "sample string 2",
    "ItemNumber": "sample string 3",
    "Rules": [
      {
        "RuleTypeId": 1,
        "RuleType": {
          "RuleTypeId": 1,
          "Description": "sample string 2",
          "Table": "sample string 3"
        },
        "Description": "sample string 2",
        "ReferenceType": "sample string 3",
        "Definitions": [
          {
            "Href": "sample string 1",
            "ReferenceId": 2,
            "PeriodId": 3,
            "Period": {
              "PeriodId": 1,
              "Description": "sample string 2"
            },
            "Amount": 4
          },
          {
            "Href": "sample string 1",
            "ReferenceId": 2,
            "PeriodId": 3,
            "Period": {
              "PeriodId": 1,
              "Description": "sample string 2"
            },
            "Amount": 4
          }
        ]
      },
      {
        "RuleTypeId": 1,
        "RuleType": {
          "RuleTypeId": 1,
          "Description": "sample string 2",
          "Table": "sample string 3"
        },
        "Description": "sample string 2",
        "ReferenceType": "sample string 3",
        "Definitions": [
          {
            "Href": "sample string 1",
            "ReferenceId": 2,
            "PeriodId": 3,
            "Period": {
              "PeriodId": 1,
              "Description": "sample string 2"
            },
            "Amount": 4
          },
          {
            "Href": "sample string 1",
            "ReferenceId": 2,
            "PeriodId": 3,
            "Period": {
              "PeriodId": 1,
              "Description": "sample string 2"
            },
            "Amount": 4
          }
        ]
      }
    ]
  },
  {
    "CommuneId": 1,
    "Name": "sample string 2",
    "ItemNumber": "sample string 3",
    "Rules": [
      {
        "RuleTypeId": 1,
        "RuleType": {
          "RuleTypeId": 1,
          "Description": "sample string 2",
          "Table": "sample string 3"
        },
        "Description": "sample string 2",
        "ReferenceType": "sample string 3",
        "Definitions": [
          {
            "Href": "sample string 1",
            "ReferenceId": 2,
            "PeriodId": 3,
            "Period": {
              "PeriodId": 1,
              "Description": "sample string 2"
            },
            "Amount": 4
          },
          {
            "Href": "sample string 1",
            "ReferenceId": 2,
            "PeriodId": 3,
            "Period": {
              "PeriodId": 1,
              "Description": "sample string 2"
            },
            "Amount": 4
          }
        ]
      },
      {
        "RuleTypeId": 1,
        "RuleType": {
          "RuleTypeId": 1,
          "Description": "sample string 2",
          "Table": "sample string 3"
        },
        "Description": "sample string 2",
        "ReferenceType": "sample string 3",
        "Definitions": [
          {
            "Href": "sample string 1",
            "ReferenceId": 2,
            "PeriodId": 3,
            "Period": {
              "PeriodId": 1,
              "Description": "sample string 2"
            },
            "Amount": 4
          },
          {
            "Href": "sample string 1",
            "ReferenceId": 2,
            "PeriodId": 3,
            "Period": {
              "PeriodId": 1,
              "Description": "sample string 2"
            },
            "Amount": 4
          }
        ]
      }
    ]
  }
]