GET api/CaseHealth/GetCaseHealth/{id}?queryby={queryby}

Get Information related to the case number or individual number

Request Information

URI Parameters

NameDescriptionTypeAdditional information
queryby

Type of request, 0: Case Number, 1: Individual Number

QueryBy

Required

id

Case or Individual Number

string

Required

Body Parameters

None.

Response Information

Resource Description

Case Information and collection of individuals

HealthCasePAModel
NameDescriptionTypeAdditional information
CaseNo

Principal Applicant Case Number

string

None.

ConcatenatedName

Principal Applicant Full Name

string

None.

VerbalName

Principal Applicant Arabic Name

string

None.

ProcessStatus

Principal Applicant Status

string

None.

EffDate

First Day of Coverage

date

None.

SiteIDOwner

UNHCR Registration Center ID

string

None.

Score

Vulnerability Score

string

None.

IndividualsList

List of individual

Collection of HealthCaseIndividualModel

None.

Response Formats

application/json, text/json

Sample:
{
  "CaseNo": "sample string 1",
  "ConcatenatedName": "sample string 2",
  "VerbalName": "sample string 3",
  "ProcessStatus": "sample string 4",
  "EffDate": "2025-10-07T12:43:30.5471052+00:00",
  "SiteIDOwner": "sample string 6",
  "Score": "sample string 7",
  "IndividualsList": [
    {
      "$id": "2",
      "IndividualID": "sample string 1",
      "GivenName": "sample string 2",
      "MiddleName": "sample string 3",
      "FamilyName": "sample string 4",
      "FatherName": "sample string 5",
      "MotherName": "sample string 6",
      "ConcatenatedName": "sample string 7",
      "VerbalName": "sample string 8",
      "Sex": "sample string 9",
      "Rel": "sample string 10",
      "MarriageStatusCode": "sample string 11",
      "DOB": "2025-10-07T12:43:30.5471052+00:00",
      "CoO": "sample string 13",
      "ProcessStatus": "sample string 14"
    },
    {
      "$ref": "2"
    }
  ]
}

application/xml, text/xml

Sample:
<HealthCasePAModel xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <CaseNo>sample string 1</CaseNo>
  <ConcatenatedName>sample string 2</ConcatenatedName>
  <VerbalName>sample string 3</VerbalName>
  <ProcessStatus>sample string 4</ProcessStatus>
  <EffDate>2025-10-07T12:43:30.5471052+00:00</EffDate>
  <SiteIDOwner>sample string 6</SiteIDOwner>
  <Score>sample string 7</Score>
  <IndividualsList>
    <HealthCaseIndividualModel>
      <IndividualID>sample string 1</IndividualID>
      <GivenName>sample string 2</GivenName>
      <MiddleName>sample string 3</MiddleName>
      <FamilyName>sample string 4</FamilyName>
      <FatherName>sample string 5</FatherName>
      <MotherName>sample string 6</MotherName>
      <ConcatenatedName>sample string 7</ConcatenatedName>
      <VerbalName>sample string 8</VerbalName>
      <Sex>sample string 9</Sex>
      <Rel>sample string 10</Rel>
      <MarriageStatusCode>sample string 11</MarriageStatusCode>
      <DOB>2025-10-07T12:43:30.5471052+00:00</DOB>
      <CoO>sample string 13</CoO>
      <ProcessStatus>sample string 14</ProcessStatus>
    </HealthCaseIndividualModel>
    <HealthCaseIndividualModel>
      <IndividualID>sample string 1</IndividualID>
      <GivenName>sample string 2</GivenName>
      <MiddleName>sample string 3</MiddleName>
      <FamilyName>sample string 4</FamilyName>
      <FatherName>sample string 5</FatherName>
      <MotherName>sample string 6</MotherName>
      <ConcatenatedName>sample string 7</ConcatenatedName>
      <VerbalName>sample string 8</VerbalName>
      <Sex>sample string 9</Sex>
      <Rel>sample string 10</Rel>
      <MarriageStatusCode>sample string 11</MarriageStatusCode>
      <DOB>2025-10-07T12:43:30.5471052+00:00</DOB>
      <CoO>sample string 13</CoO>
      <ProcessStatus>sample string 14</ProcessStatus>
    </HealthCaseIndividualModel>
  </IndividualsList>
</HealthCasePAModel>

multipart/form-data

Sample:
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CaseNo"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ConcatenatedName"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="VerbalName"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ProcessStatus"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="EffDate"

2025-10-07T12:43:30.5471052+00:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="SiteIDOwner"

sample string 6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Score"

sample string 7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IndividualsList[0].IndividualID"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IndividualsList[0].GivenName"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IndividualsList[0].MiddleName"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IndividualsList[0].FamilyName"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IndividualsList[0].FatherName"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IndividualsList[0].MotherName"

sample string 6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IndividualsList[0].ConcatenatedName"

sample string 7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IndividualsList[0].VerbalName"

sample string 8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IndividualsList[0].Sex"

sample string 9
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IndividualsList[0].Rel"

sample string 10
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IndividualsList[0].MarriageStatusCode"

sample string 11
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IndividualsList[0].DOB"

2025-10-07T12:43:30.5471052+00:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IndividualsList[0].CoO"

sample string 13
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IndividualsList[0].ProcessStatus"

sample string 14
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IndividualsList[1].IndividualID"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IndividualsList[1].GivenName"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IndividualsList[1].MiddleName"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IndividualsList[1].FamilyName"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IndividualsList[1].FatherName"

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IndividualsList[1].MotherName"

sample string 6
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IndividualsList[1].ConcatenatedName"

sample string 7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IndividualsList[1].VerbalName"

sample string 8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IndividualsList[1].Sex"

sample string 9
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IndividualsList[1].Rel"

sample string 10
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IndividualsList[1].MarriageStatusCode"

sample string 11
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IndividualsList[1].DOB"

2025-10-07T12:43:30.5471052+00:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IndividualsList[1].CoO"

sample string 13
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IndividualsList[1].ProcessStatus"

sample string 14
--MultipartDataMediaFormatterBoundary1q2w3e--