GET api/Centres/GetCentres/{instCode}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
instCode

string

Required

Body Parameters

None.

Response Information

Resource Description

CentresResponse
NameDescriptionTypeAdditional 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": "99bec6a7-21ab-498c-af0c-09f3ecd50860",
  "UsesCentres": true,
  "CentreLabelName": "sample string 3",
  "CentresLabelName": "sample string 4",
  "DefaultCentreUUID": "c2fedd41-85f9-4628-99b0-2b89f20e9e74",
  "Centres": [
    {
      "CentreUUID": "083595a8-06cc-4adc-b201-43047ec2dc07",
      "InstitutionUUID": "7ab597d7-7331-4304-a2f9-6a02be516797",
      "CentreName": "sample string 3",
      "DefaultCentre": true,
      "Active": true
    },
    {
      "CentreUUID": "083595a8-06cc-4adc-b201-43047ec2dc07",
      "InstitutionUUID": "7ab597d7-7331-4304-a2f9-6a02be516797",
      "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>083595a8-06cc-4adc-b201-43047ec2dc07</CentreUUID>
      <DefaultCentre>true</DefaultCentre>
      <InstitutionUUID>7ab597d7-7331-4304-a2f9-6a02be516797</InstitutionUUID>
    </Centres>
    <Centres>
      <Active>true</Active>
      <CentreName>sample string 3</CentreName>
      <CentreUUID>083595a8-06cc-4adc-b201-43047ec2dc07</CentreUUID>
      <DefaultCentre>true</DefaultCentre>
      <InstitutionUUID>7ab597d7-7331-4304-a2f9-6a02be516797</InstitutionUUID>
    </Centres>
  </Centres>
  <CentresLabelName>sample string 4</CentresLabelName>
  <DefaultCentreUUID>c2fedd41-85f9-4628-99b0-2b89f20e9e74</DefaultCentreUUID>
  <ErrorMessage>sample string 7</ErrorMessage>
  <InstitutionUUID>99bec6a7-21ab-498c-af0c-09f3ecd50860</InstitutionUUID>
  <IsSuccess>true</IsSuccess>
  <UsesCentres>true</UsesCentres>
</CentresResponse>