GET api/inquiry/InquirePerson?NationalCode={NationalCode}&BirthDate={BirthDate}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
NationalCode

string

Required

BirthDate

string

Matching regular expression pattern: ^[1-4]\d{3}\/((0[1-6]\/((3[0-1])|([1-2][0-9])|(0[1-9])))|((1[0-2]|(0[7-9]))\/(30|31|([1-2][0-9])|(0[1-9]))))$

Body Parameters

None.

Response Information

Resource Description

PersonViewModel
NameDescriptionTypeAdditional information
Data

Person

None.

HasErrors

boolean

None.

Messages

Collection of string

None.

Response Formats

application/json, text/json

Sample:
{
  "Data": {
    "FNAME_FA": "sample string 1",
    "FNAME_EN": "sample string 2",
    "LNAME_FA": "sample string 3",
    "LNAME_EN": "sample string 4",
    "FATHER_NAME_FA": "sample string 5",
    "FATHER_NAME_EN": "sample string 6",
    "IDNUMBER": 7,
    "IDSERI": "sample string 8",
    "IDSERIAL": 9,
    "BIRTHDATE": "sample string 10",
    "NATIONAL_NUMBER": "sample string 11",
    "GENDER": "sample string 12",
    "IS_DEAD": "sample string 13",
    "DEATHDATE": {},
    "IS_VERIFIED": "sample string 15",
    "SHABA_CODE": "sample string 16",
    "PDM_ID": 17,
    "ZIPCODE": "sample string 18"
  },
  "HasErrors": false,
  "Messages": []
}

application/xml, text/xml

Sample:
<PersonViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Barg.PodAPI.Models">
  <Messages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Barg.WebAPI.Models" />
  <Data>
    <BirthDate>sample string 10</BirthDate>
    <DeathDate />
    <FatherName_En>sample string 6</FatherName_En>
    <FatherName_Fa>sample string 5</FatherName_Fa>
    <FirstName_En>sample string 2</FirstName_En>
    <FirstName_Fa>sample string 1</FirstName_Fa>
    <Gender>sample string 12</Gender>
    <IdNumber>7</IdNumber>
    <IdSeri>sample string 8</IdSeri>
    <IdSerial>9</IdSerial>
    <IsDead>sample string 13</IsDead>
    <IsVerified>sample string 15</IsVerified>
    <LastName_En>sample string 4</LastName_En>
    <LastName_Fa>sample string 3</LastName_Fa>
    <NationalNumber>sample string 11</NationalNumber>
    <PDMID>17</PDMID>
    <SHABACODE>sample string 16</SHABACODE>
    <ZIPCODE>sample string 18</ZIPCODE>
  </Data>
</PersonViewModel>