GET api/v{version}/organisation?translations={translations}
Get all the available dart organisations from the system.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
translations |
if true, the available translations will be returned. If the header contains a Multilanguage parameter, the translations will also be returned. |
boolean |
Default value is False |
version | string |
None. |
Body Parameters
None.
Response Information
Resource Description
Collection of OrganisationDetailViewModelName | Description | Type | Additional information |
---|---|---|---|
OrganisationId | integer |
None. |
|
Name | string |
None. |
|
Abbreviation | string |
None. |
|
Formation | date |
None. |
|
Description | string |
None. |
|
DescriptionTranslations | Dictionary of string [key] and string [value] |
None. |
|
Url | string |
None. |
|
Attachment |
A photo of the organisation. |
string |
None. |
AttachmentContentType |
The content type of the photo. |
string |
None. |
Meta |
Provides list of meta data about the entity |
Dictionary of string [key] and string [value] |
None. |
Response Formats
application/json, text/json
Sample:
[ { "OrganisationId": 1, "Name": "sample string 2", "Abbreviation": "sample string 3", "Formation": "2023-04-01T02:21:24.8566253+02:00", "Description": "sample string 5", "DescriptionTranslations": { "sample string 1": "sample string 2", "sample string 3": "sample string 4" }, "Url": "sample string 6", "Meta": { "sample string 1": "sample string 2", "sample string 3": "sample string 4" } }, { "OrganisationId": 1, "Name": "sample string 2", "Abbreviation": "sample string 3", "Formation": "2023-04-01T02:21:24.8566253+02:00", "Description": "sample string 5", "DescriptionTranslations": { "sample string 1": "sample string 2", "sample string 3": "sample string 4" }, "Url": "sample string 6", "Meta": { "sample string 1": "sample string 2", "sample string 3": "sample string 4" } } ]
application/xml, text/xml
Sample:
<ArrayOfOrganisationDetailViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DartStat.Web.Areas.Apiv2.Models"> <OrganisationDetailViewModel> <Abbreviation>sample string 3</Abbreviation> <Attachment>sample string 7</Attachment> <AttachmentContentType>sample string 8</AttachmentContentType> <Description>sample string 5</Description> <DescriptionTranslations xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringstring> <d3p1:Key>sample string 1</d3p1:Key> <d3p1:Value>sample string 2</d3p1:Value> </d3p1:KeyValueOfstringstring> <d3p1:KeyValueOfstringstring> <d3p1:Key>sample string 3</d3p1:Key> <d3p1:Value>sample string 4</d3p1:Value> </d3p1:KeyValueOfstringstring> </DescriptionTranslations> <Formation>2023-04-01T02:21:24.8566253+02:00</Formation> <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringstring> <d3p1:Key>sample string 1</d3p1:Key> <d3p1:Value>sample string 2</d3p1:Value> </d3p1:KeyValueOfstringstring> <d3p1:KeyValueOfstringstring> <d3p1:Key>sample string 3</d3p1:Key> <d3p1:Value>sample string 4</d3p1:Value> </d3p1:KeyValueOfstringstring> </Meta> <Name>sample string 2</Name> <OrganisationId>1</OrganisationId> <Url>sample string 6</Url> </OrganisationDetailViewModel> <OrganisationDetailViewModel> <Abbreviation>sample string 3</Abbreviation> <Attachment>sample string 7</Attachment> <AttachmentContentType>sample string 8</AttachmentContentType> <Description>sample string 5</Description> <DescriptionTranslations xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringstring> <d3p1:Key>sample string 1</d3p1:Key> <d3p1:Value>sample string 2</d3p1:Value> </d3p1:KeyValueOfstringstring> <d3p1:KeyValueOfstringstring> <d3p1:Key>sample string 3</d3p1:Key> <d3p1:Value>sample string 4</d3p1:Value> </d3p1:KeyValueOfstringstring> </DescriptionTranslations> <Formation>2023-04-01T02:21:24.8566253+02:00</Formation> <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringstring> <d3p1:Key>sample string 1</d3p1:Key> <d3p1:Value>sample string 2</d3p1:Value> </d3p1:KeyValueOfstringstring> <d3p1:KeyValueOfstringstring> <d3p1:Key>sample string 3</d3p1:Key> <d3p1:Value>sample string 4</d3p1:Value> </d3p1:KeyValueOfstringstring> </Meta> <Name>sample string 2</Name> <OrganisationId>1</OrganisationId> <Url>sample string 6</Url> </OrganisationDetailViewModel> </ArrayOfOrganisationDetailViewModel>