POST report/getfamilyrecipientreportbyrecip

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
recipId	string	None.
recipName	string	None.
reportFor	string	None.
familyId	integer	None.
reportMonth	integer	None.
reportYear	integer	None.
providerId	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "recipId": "sample string 1",
  "recipName": "sample string 2",
  "reportFor": "sample string 3",
  "familyId": 4,
  "reportMonth": 5,
  "reportYear": 6,
  "providerId": 7
}

application/xml, text/xml

Sample:

<FamilyRecipientReport.FamilyRecipInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SW99.Medical.Reports.DTOs">
  <familyId>4</familyId>
  <providerId>7</providerId>
  <recipId>sample string 1</recipId>
  <recipName>sample string 2</recipName>
  <reportFor>sample string 3</reportFor>
  <reportMonth>5</reportMonth>
  <reportYear>6</reportYear>
</FamilyRecipientReport.FamilyRecipInfo>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of FamilyRecipientReport

Name	Type	Additional information
RECIP_ID	string	None.
RECIP_FIRST_NAME	string	None.
RECIP_LAST_NAME	string	None.
AGE	integer	None.
SEX	string	None.
BIRTH_DATE	date	None.
BIRTHDATEs	string	None.
AID_CATEGORY	integer	None.
TIER	integer	None.
START_DATE	date	None.
STARTDATEs	string	None.
STOP_DATE	date	None.
RECIP_MID_NAME	string	None.
AID_CATEGORY_DESC	string	None.
END_DATE	string	None.
FAMILY_REC_ID	integer	None.
REPORT_MONTH	integer	None.
REPORT_YEAR	integer	None.
Type	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "RECIP_ID": "sample string 1",
    "RECIP_FIRST_NAME": "sample string 2",
    "RECIP_LAST_NAME": "sample string 3",
    "AGE": 4,
    "SEX": "sample string 5",
    "BIRTH_DATE": "2024-09-29T01:24:54.4822113+00:00",
    "BIRTHDATEs": "sample string 7",
    "AID_CATEGORY": 8,
    "TIER": 9,
    "START_DATE": "2024-09-29T01:24:54.4822113+00:00",
    "STARTDATEs": "sample string 11",
    "STOP_DATE": "2024-09-29T01:24:54.4822113+00:00",
    "RECIP_MID_NAME": "sample string 13",
    "AID_CATEGORY_DESC": "sample string 14",
    "END_DATE": "9/29/2024 1:24:54 AM",
    "FAMILY_REC_ID": 15,
    "REPORT_MONTH": 16,
    "REPORT_YEAR": 17,
    "Type": "sample string 18"
  },
  {
    "RECIP_ID": "sample string 1",
    "RECIP_FIRST_NAME": "sample string 2",
    "RECIP_LAST_NAME": "sample string 3",
    "AGE": 4,
    "SEX": "sample string 5",
    "BIRTH_DATE": "2024-09-29T01:24:54.4822113+00:00",
    "BIRTHDATEs": "sample string 7",
    "AID_CATEGORY": 8,
    "TIER": 9,
    "START_DATE": "2024-09-29T01:24:54.4822113+00:00",
    "STARTDATEs": "sample string 11",
    "STOP_DATE": "2024-09-29T01:24:54.4822113+00:00",
    "RECIP_MID_NAME": "sample string 13",
    "AID_CATEGORY_DESC": "sample string 14",
    "END_DATE": "9/29/2024 1:24:54 AM",
    "FAMILY_REC_ID": 15,
    "REPORT_MONTH": 16,
    "REPORT_YEAR": 17,
    "Type": "sample string 18"
  }
]

application/xml, text/xml

Sample:

<ArrayOfFamilyRecipientReport xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SW99.Medical.Reports.DTOs">
  <FamilyRecipientReport>
    <AGE>4</AGE>
    <AID_CATEGORY>8</AID_CATEGORY>
    <AID_CATEGORY_DESC>sample string 14</AID_CATEGORY_DESC>
    <BIRTHDATEs>sample string 7</BIRTHDATEs>
    <BIRTH_DATE>2024-09-29T01:24:54.4822113+00:00</BIRTH_DATE>
    <FAMILY_REC_ID>15</FAMILY_REC_ID>
    <RECIP_FIRST_NAME>sample string 2</RECIP_FIRST_NAME>
    <RECIP_ID>sample string 1</RECIP_ID>
    <RECIP_LAST_NAME>sample string 3</RECIP_LAST_NAME>
    <RECIP_MID_NAME>sample string 13</RECIP_MID_NAME>
    <REPORT_MONTH>16</REPORT_MONTH>
    <REPORT_YEAR>17</REPORT_YEAR>
    <SEX>sample string 5</SEX>
    <STARTDATEs>sample string 11</STARTDATEs>
    <START_DATE>2024-09-29T01:24:54.4822113+00:00</START_DATE>
    <STOP_DATE>2024-09-29T01:24:54.4822113+00:00</STOP_DATE>
    <TIER>9</TIER>
    <Type>sample string 18</Type>
  </FamilyRecipientReport>
  <FamilyRecipientReport>
    <AGE>4</AGE>
    <AID_CATEGORY>8</AID_CATEGORY>
    <AID_CATEGORY_DESC>sample string 14</AID_CATEGORY_DESC>
    <BIRTHDATEs>sample string 7</BIRTHDATEs>
    <BIRTH_DATE>2024-09-29T01:24:54.4822113+00:00</BIRTH_DATE>
    <FAMILY_REC_ID>15</FAMILY_REC_ID>
    <RECIP_FIRST_NAME>sample string 2</RECIP_FIRST_NAME>
    <RECIP_ID>sample string 1</RECIP_ID>
    <RECIP_LAST_NAME>sample string 3</RECIP_LAST_NAME>
    <RECIP_MID_NAME>sample string 13</RECIP_MID_NAME>
    <REPORT_MONTH>16</REPORT_MONTH>
    <REPORT_YEAR>17</REPORT_YEAR>
    <SEX>sample string 5</SEX>
    <STARTDATEs>sample string 11</STARTDATEs>
    <START_DATE>2024-09-29T01:24:54.4822113+00:00</START_DATE>
    <STOP_DATE>2024-09-29T01:24:54.4822113+00:00</STOP_DATE>
    <TIER>9</TIER>
    <Type>sample string 18</Type>
  </FamilyRecipientReport>
</ArrayOfFamilyRecipientReport>