GET api/organisations

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of API.Domain.ViewModels.Organisation.OrganisationListItem

Name	Type	Additional information
OrganisationTypeId	globally unique identifier	None.
ParentName	string	None.
ParentId	globally unique identifier	None.
Depth	integer	None.
ImmediateDescendantCount	integer	None.
Id	globally unique identifier	None.
Address	API.Domain.ViewModels.Common.SiteAddress	None.
OrganisationTypeName	string	None.
Name	string	None.
ExternalReference	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "organisationTypeId": "e767db38-4352-40de-9ca2-2153f688ee5f",
    "parentName": "sample string 2",
    "parentId": "ea2be5f8-4dd9-4e04-ac0a-b595c95e8620",
    "depth": 4,
    "immediateDescendantCount": 5,
    "id": "bcd38ac2-c63e-4d01-9165-8422405917ee",
    "address": {
      "id": "3a2e51c0-64ef-47dd-a60a-6428e69c8b99",
      "address1": "sample string 1",
      "address2": "sample string 2",
      "address3": "sample string 3",
      "address4": "sample string 4",
      "city": "sample string 5",
      "county": "sample string 6",
      "country": "sample string 7",
      "zip": "sample string 8"
    },
    "organisationTypeName": "sample string 7",
    "name": "sample string 8",
    "externalReference": "sample string 9"
  },
  {
    "organisationTypeId": "e767db38-4352-40de-9ca2-2153f688ee5f",
    "parentName": "sample string 2",
    "parentId": "ea2be5f8-4dd9-4e04-ac0a-b595c95e8620",
    "depth": 4,
    "immediateDescendantCount": 5,
    "id": "bcd38ac2-c63e-4d01-9165-8422405917ee",
    "address": {
      "id": "3a2e51c0-64ef-47dd-a60a-6428e69c8b99",
      "address1": "sample string 1",
      "address2": "sample string 2",
      "address3": "sample string 3",
      "address4": "sample string 4",
      "city": "sample string 5",
      "county": "sample string 6",
      "country": "sample string 7",
      "zip": "sample string 8"
    },
    "organisationTypeName": "sample string 7",
    "name": "sample string 8",
    "externalReference": "sample string 9"
  }
]

text/html

Sample:

[{"organisationTypeId":"e767db38-4352-40de-9ca2-2153f688ee5f","parentName":"sample string 2","parentId":"ea2be5f8-4dd9-4e04-ac0a-b595c95e8620","depth":4,"immediateDescendantCount":5,"id":"bcd38ac2-c63e-4d01-9165-8422405917ee","address":{"id":"3a2e51c0-64ef-47dd-a60a-6428e69c8b99","address1":"sample string 1","address2":"sample string 2","address3":"sample string 3","address4":"sample string 4","city":"sample string 5","county":"sample string 6","country":"sample string 7","zip":"sample string 8"},"organisationTypeName":"sample string 7","name":"sample string 8","externalReference":"sample string 9"},{"organisationTypeId":"e767db38-4352-40de-9ca2-2153f688ee5f","parentName":"sample string 2","parentId":"ea2be5f8-4dd9-4e04-ac0a-b595c95e8620","depth":4,"immediateDescendantCount":5,"id":"bcd38ac2-c63e-4d01-9165-8422405917ee","address":{"id":"3a2e51c0-64ef-47dd-a60a-6428e69c8b99","address1":"sample string 1","address2":"sample string 2","address3":"sample string 3","address4":"sample string 4","city":"sample string 5","county":"sample string 6","country":"sample string 7","zip":"sample string 8"},"organisationTypeName":"sample string 7","name":"sample string 8","externalReference":"sample string 9"}]