GET api/Centres/GetCentres/{instCode}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| instCode | string |
Required |
Body Parameters
None.
Response Information
Resource Description
CentresResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| InstitutionUUID | globally unique identifier |
None. |
|
| UsesCentres | boolean |
None. |
|
| CentreLabelName | string |
None. |
|
| CentresLabelName | string |
None. |
|
| DefaultCentreUUID | globally unique identifier |
None. |
|
| Centres | Collection of Centres |
None. |
|
| IsSuccess | boolean |
None. |
|
| ErrorMessage | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"InstitutionUUID": "b3618279-eb10-4c82-afa9-9fa1a0e4997d",
"UsesCentres": true,
"CentreLabelName": "sample string 3",
"CentresLabelName": "sample string 4",
"DefaultCentreUUID": "afd4a39b-3b60-4ff1-9e45-17cf5f153cdf",
"Centres": [
{
"CentreUUID": "cf8c5e3d-b57b-4dac-815a-62e4cfb209d6",
"InstitutionUUID": "b78b2363-23ef-4a9d-914c-2daa3f45ddb8",
"CentreName": "sample string 3",
"DefaultCentre": true,
"Active": true
},
{
"CentreUUID": "cf8c5e3d-b57b-4dac-815a-62e4cfb209d6",
"InstitutionUUID": "b78b2363-23ef-4a9d-914c-2daa3f45ddb8",
"CentreName": "sample string 3",
"DefaultCentre": true,
"Active": true
}
],
"IsSuccess": true,
"ErrorMessage": "sample string 7"
}
text/xml
Sample:
<CentresResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/gbddcwebapi.Models">
<CentreLabelName>sample string 3</CentreLabelName>
<Centres>
<Centres>
<Active>true</Active>
<CentreName>sample string 3</CentreName>
<CentreUUID>cf8c5e3d-b57b-4dac-815a-62e4cfb209d6</CentreUUID>
<DefaultCentre>true</DefaultCentre>
<InstitutionUUID>b78b2363-23ef-4a9d-914c-2daa3f45ddb8</InstitutionUUID>
</Centres>
<Centres>
<Active>true</Active>
<CentreName>sample string 3</CentreName>
<CentreUUID>cf8c5e3d-b57b-4dac-815a-62e4cfb209d6</CentreUUID>
<DefaultCentre>true</DefaultCentre>
<InstitutionUUID>b78b2363-23ef-4a9d-914c-2daa3f45ddb8</InstitutionUUID>
</Centres>
</Centres>
<CentresLabelName>sample string 4</CentresLabelName>
<DefaultCentreUUID>afd4a39b-3b60-4ff1-9e45-17cf5f153cdf</DefaultCentreUUID>
<ErrorMessage>sample string 7</ErrorMessage>
<InstitutionUUID>b3618279-eb10-4c82-afa9-9fa1a0e4997d</InstitutionUUID>
<IsSuccess>true</IsSuccess>
<UsesCentres>true</UsesCentres>
</CentresResponse>