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	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": "68556fd3-6620-43fc-a6b1-c13f7377ef39",
  "UsesCentres": true,
  "CentreLabelName": "sample string 3",
  "CentresLabelName": "sample string 4",
  "DefaultCentreUUID": "be92cbce-e189-4421-8641-0dae3eb79c69",
  "Centres": [
    {
      "CentreUUID": "f61ead22-46e5-4ce8-94df-260a48ffe197",
      "InstitutionUUID": "53d6f5de-8793-4d0e-871b-fa95e01f80db",
      "CentreName": "sample string 3",
      "DefaultCentre": true,
      "Active": true
    },
    {
      "CentreUUID": "f61ead22-46e5-4ce8-94df-260a48ffe197",
      "InstitutionUUID": "53d6f5de-8793-4d0e-871b-fa95e01f80db",
      "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>f61ead22-46e5-4ce8-94df-260a48ffe197</CentreUUID>
      <DefaultCentre>true</DefaultCentre>
      <InstitutionUUID>53d6f5de-8793-4d0e-871b-fa95e01f80db</InstitutionUUID>
    </Centres>
    <Centres>
      <Active>true</Active>
      <CentreName>sample string 3</CentreName>
      <CentreUUID>f61ead22-46e5-4ce8-94df-260a48ffe197</CentreUUID>
      <DefaultCentre>true</DefaultCentre>
      <InstitutionUUID>53d6f5de-8793-4d0e-871b-fa95e01f80db</InstitutionUUID>
    </Centres>
  </Centres>
  <CentresLabelName>sample string 4</CentresLabelName>
  <DefaultCentreUUID>be92cbce-e189-4421-8641-0dae3eb79c69</DefaultCentreUUID>
  <ErrorMessage>sample string 7</ErrorMessage>
  <InstitutionUUID>68556fd3-6620-43fc-a6b1-c13f7377ef39</InstitutionUUID>
  <IsSuccess>true</IsSuccess>
  <UsesCentres>true</UsesCentres>
</CentresResponse>