Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

A list of communities.

Collection of Nano.Community
NameDescriptionTypeAdditional information
code

Gets or sets the code.

string

None.

description

Gets or sets the description.

string

None.

isActive

Gets or sets a value indicating whether this is active.

boolean

None.

address

Gets or sets the address identifier.

integer

None.

id

Gets or sets the community identifier.

integer

None.

corporatePartner

Gets or sets the corporate partner identifier.

integer

None.

organization

Gets or sets the organization identifier.

string

None.

parentCommunity

Gets or sets the parent community identifier.

integer

None.

provider

Gets or sets the provider identifier.

integer

None.

forwardCommitments

Gets or sets the forward commitment identifiers.

Collection of integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "code": "sample String 1",
    "description": "sample String 2",
    "isActive": true,
    "address": "1",
    "id": "4",
    "corporatePartner": "1",
    "organization": "sample String 5",
    "parentCommunity": "1",
    "provider": "1",
    "forwardCommitments": [
      "1",
      "2"
    ]
  },
  {
    "code": "sample String 1",
    "description": "sample String 2",
    "isActive": true,
    "address": "1",
    "id": "4",
    "corporatePartner": "1",
    "organization": "sample String 5",
    "parentCommunity": "1",
    "provider": "1",
    "forwardCommitments": [
      "1",
      "2"
    ]
  }
]

text/html

Sample:
[{"code":"sample String 1","description":"sample String 2","isActive":true,"address":"1","id":"4","corporatePartner":"1","organization":"sample String 5","parentCommunity":"1","provider":"1","forwardCommitments":["1","2"]},{"code":"sample String 1","description":"sample String 2","isActive":true,"address":"1","id":"4","corporatePartner":"1","organization":"sample String 5","parentCommunity":"1","provider":"1","forwardCommitments":["1","2"]}]

application/vnd.api+json

Sample:

Sample not available.