GET API/IVRApiDatas?caseNumber={caseNumber}

GET: api/IVRApiDatas/5

Request Information

URI Parameters

Name	Description	Type	Additional information
caseNumber	UNHCR Case Number	string	Required

Body Parameters

None.

Response Information

Resource Description

Case Information

vIVRFinal

Name	Type	Additional information
CaseNo	string	None.
DOB	date	None.
CoO	string	None.
LegalStatus	string	None.
HaveSpecificNeeds	boolean	None.
CoALevel1	string	None.
DocumentNumber	string	None.
DocumentStatusCode	string	None.
DocumentDateExpire	date	None.
IsClose	boolean	None.
IsCamp	boolean	None.
FamilySize	integer	None.
CashAssistanceTypeName	string	None.
CashAssistanceLastProvideDate	date	None.
CashAssistanceFundedBy	string	None.
WinterAssistanceTypeName	string	None.
WinterAssistanceLastProvideDate	date	None.
WinterAssistanceFundedBy	string	None.
EligibilityTypeName	string	None.
EligibilityStatus	string	None.
EligibilityLastAction	string	None.
PovertyEligibilityTypeName	string	None.
PovertyEligibilityStatus	string	None.
PovertyEligibilityLastAction	string	None.
CashEligibilityTypeName	string	None.
CashEligibilityDeliveryMethod	string	None.
CashEligibilityStatus	string	None.
CashEligibilityLastAction	string	None.
HealthEligibilityTypeName	string	None.
HealthEligibilityStatus	string	None.
HealthEligibilityLastAction	string	None.
IsReferral	boolean	None.
ReferralDate	date	None.
IsReferralLastAction	string	None.
IsReferralMoreThan2Years	boolean	None.
IsOpenTicketHomeVisit	boolean	None.
IsOpenTicketATM	boolean	None.
IsOpenTicketRegistration	boolean	None.
IsOpenTicketRST	boolean	None.
IsOpenTicketAppel	boolean	None.
IsOpenTicketRotation	boolean	None.
IsWinterBlock	boolean	None.
BlockName	string	None.
WinterFunded	string	None.
BlockAssistanceTypeName	string	None.
AssistanceTypeID	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "CaseNo": "sample string 1",
  "DOB": "2025-10-16T04:21:12.6061336+00:00",
  "CoO": "sample string 2",
  "LegalStatus": "sample string 3",
  "HaveSpecificNeeds": true,
  "CoALevel1": "sample string 4",
  "DocumentNumber": "sample string 5",
  "DocumentStatusCode": "sample string 6",
  "DocumentDateExpire": "2025-10-16T04:21:12.6061336+00:00",
  "IsClose": true,
  "IsCamp": true,
  "FamilySize": 1,
  "CashAssistanceTypeName": "sample string 7",
  "CashAssistanceLastProvideDate": "2025-10-16T04:21:12.6061336+00:00",
  "CashAssistanceFundedBy": "sample string 8",
  "WinterAssistanceTypeName": "sample string 9",
  "WinterAssistanceLastProvideDate": "2025-10-16T04:21:12.6061336+00:00",
  "WinterAssistanceFundedBy": "sample string 10",
  "EligibilityTypeName": "sample string 11",
  "EligibilityStatus": "sample string 12",
  "EligibilityLastAction": "sample string 13",
  "PovertyEligibilityTypeName": "sample string 14",
  "PovertyEligibilityStatus": "sample string 15",
  "PovertyEligibilityLastAction": "sample string 16",
  "CashEligibilityTypeName": "sample string 17",
  "CashEligibilityDeliveryMethod": "sample string 18",
  "CashEligibilityStatus": "sample string 19",
  "CashEligibilityLastAction": "sample string 20",
  "HealthEligibilityTypeName": "sample string 21",
  "HealthEligibilityStatus": "sample string 22",
  "HealthEligibilityLastAction": "sample string 23",
  "IsReferral": true,
  "ReferralDate": "2025-10-16T04:21:12.6061336+00:00",
  "IsReferralLastAction": "sample string 24",
  "IsReferralMoreThan2Years": true,
  "IsOpenTicketHomeVisit": true,
  "IsOpenTicketATM": true,
  "IsOpenTicketRegistration": true,
  "IsOpenTicketRST": true,
  "IsOpenTicketAppel": true,
  "IsOpenTicketRotation": true,
  "IsWinterBlock": true,
  "BlockName": "sample string 25",
  "WinterFunded": "sample string 26",
  "BlockAssistanceTypeName": "sample string 27",
  "AssistanceTypeID": 28
}

application/xml, text/xml

Sample:

<vIVRFinal xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <CaseNo>sample string 1</CaseNo>
  <DOB>2025-10-16T04:21:12.6061336+00:00</DOB>
  <CoO>sample string 2</CoO>
  <LegalStatus>sample string 3</LegalStatus>
  <HaveSpecificNeeds>true</HaveSpecificNeeds>
  <CoALevel1>sample string 4</CoALevel1>
  <DocumentNumber>sample string 5</DocumentNumber>
  <DocumentStatusCode>sample string 6</DocumentStatusCode>
  <DocumentDateExpire>2025-10-16T04:21:12.6061336+00:00</DocumentDateExpire>
  <IsClose>true</IsClose>
  <IsCamp>true</IsCamp>
  <FamilySize>1</FamilySize>
  <CashAssistanceTypeName>sample string 7</CashAssistanceTypeName>
  <CashAssistanceLastProvideDate>2025-10-16T04:21:12.6061336+00:00</CashAssistanceLastProvideDate>
  <CashAssistanceFundedBy>sample string 8</CashAssistanceFundedBy>
  <WinterAssistanceTypeName>sample string 9</WinterAssistanceTypeName>
  <WinterAssistanceLastProvideDate>2025-10-16T04:21:12.6061336+00:00</WinterAssistanceLastProvideDate>
  <WinterAssistanceFundedBy>sample string 10</WinterAssistanceFundedBy>
  <EligibilityTypeName>sample string 11</EligibilityTypeName>
  <EligibilityStatus>sample string 12</EligibilityStatus>
  <EligibilityLastAction>sample string 13</EligibilityLastAction>
  <PovertyEligibilityTypeName>sample string 14</PovertyEligibilityTypeName>
  <PovertyEligibilityStatus>sample string 15</PovertyEligibilityStatus>
  <PovertyEligibilityLastAction>sample string 16</PovertyEligibilityLastAction>
  <CashEligibilityTypeName>sample string 17</CashEligibilityTypeName>
  <CashEligibilityDeliveryMethod>sample string 18</CashEligibilityDeliveryMethod>
  <CashEligibilityStatus>sample string 19</CashEligibilityStatus>
  <CashEligibilityLastAction>sample string 20</CashEligibilityLastAction>
  <HealthEligibilityTypeName>sample string 21</HealthEligibilityTypeName>
  <HealthEligibilityStatus>sample string 22</HealthEligibilityStatus>
  <HealthEligibilityLastAction>sample string 23</HealthEligibilityLastAction>
  <IsReferral>true</IsReferral>
  <ReferralDate>2025-10-16T04:21:12.6061336+00:00</ReferralDate>
  <IsReferralLastAction>sample string 24</IsReferralLastAction>
  <IsReferralMoreThan2Years>true</IsReferralMoreThan2Years>
  <IsOpenTicketHomeVisit>true</IsOpenTicketHomeVisit>
  <IsOpenTicketATM>true</IsOpenTicketATM>
  <IsOpenTicketRegistration>true</IsOpenTicketRegistration>
  <IsOpenTicketRST>true</IsOpenTicketRST>
  <IsOpenTicketAppel>true</IsOpenTicketAppel>
  <IsOpenTicketRotation>true</IsOpenTicketRotation>
  <IsWinterBlock>true</IsWinterBlock>
  <BlockName>sample string 25</BlockName>
  <WinterFunded>sample string 26</WinterFunded>
  <BlockAssistanceTypeName>sample string 27</BlockAssistanceTypeName>
  <AssistanceTypeID>28</AssistanceTypeID>
</vIVRFinal>

multipart/form-data

Sample:

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

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

2025-10-16T04:21:12.6061336+00:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CoO"

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

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

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CoALevel1"

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

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="DocumentStatusCode"

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

2025-10-16T04:21:12.6061336+00:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IsClose"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IsCamp"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="FamilySize"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CashAssistanceTypeName"

sample string 7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CashAssistanceLastProvideDate"

2025-10-16T04:21:12.6061336+00:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CashAssistanceFundedBy"

sample string 8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="WinterAssistanceTypeName"

sample string 9
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="WinterAssistanceLastProvideDate"

2025-10-16T04:21:12.6061336+00:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="WinterAssistanceFundedBy"

sample string 10
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="EligibilityTypeName"

sample string 11
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="EligibilityStatus"

sample string 12
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="EligibilityLastAction"

sample string 13
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="PovertyEligibilityTypeName"

sample string 14
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="PovertyEligibilityStatus"

sample string 15
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="PovertyEligibilityLastAction"

sample string 16
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CashEligibilityTypeName"

sample string 17
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CashEligibilityDeliveryMethod"

sample string 18
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CashEligibilityStatus"

sample string 19
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CashEligibilityLastAction"

sample string 20
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="HealthEligibilityTypeName"

sample string 21
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="HealthEligibilityStatus"

sample string 22
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="HealthEligibilityLastAction"

sample string 23
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IsReferral"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ReferralDate"

2025-10-16T04:21:12.6061336+00:00
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IsReferralLastAction"

sample string 24
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IsReferralMoreThan2Years"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IsOpenTicketHomeVisit"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IsOpenTicketATM"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IsOpenTicketRegistration"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IsOpenTicketRST"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IsOpenTicketAppel"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IsOpenTicketRotation"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="IsWinterBlock"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="BlockName"

sample string 25
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="WinterFunded"

sample string 26
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="BlockAssistanceTypeName"

sample string 27
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="AssistanceTypeID"

28
--MultipartDataMediaFormatterBoundary1q2w3e--