POST api/Login/PatientLogin?isPassport={isPassport}&isOtp={isOtp}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
isPassport

boolean

Required
isOtp

boolean

Default value is False

Body Parameters

PatientLoginArgs
NameDescriptionTypeAdditional information
EntityId

string

None.
Password

string

None.
RecaptchaResponse

string

None.

Request Formats

application/json, text/json

Sample: 
{
  "EntityId": "sample string 1",
  "Password": "sample string 2",
  "RecaptchaResponse": "sample string 3"
}

application/xml, text/xml

Sample: 
<LoginController.PatientLoginArgs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IMedical.Controllers">
  <EntityId>sample string 1</EntityId>
  <Password>sample string 2</Password>
  <RecaptchaResponse>sample string 3</RecaptchaResponse>
</LoginController.PatientLoginArgs>

application/x-www-form-urlencoded

Sample:

Sample not available.

application/bson

Sample: 
Binary JSON content. See http://bsonspec.org for details.

Response Information

Resource Description

ConnDataForPatient
NameDescriptionTypeAdditional information
PatData

ExternalPatientData

None.
PatAppointments

Collection of PatientAppointmentExternal

None.
Version

string

None.
AddPatient

string

None.
ExpireDate

date

None.
Token

string

None.
DropConnKey

string

None.
SessionId

string

None.
MaxFutureAppontments

integer

None.
SmsConfirm

boolean

None.

Response Formats

application/json, text/json

Sample: 
{
  "PatData": {
    "cust_num": 1,
    "id_num": "sample string 1",
    "pasport": "sample string 2",
    "last_name": "sample string 3",
    "first_name": "sample string 4",
    "sex": "sample string 5",
    "born": "2026-01-23T17:52:18.2745189+02:00",
    "city_code": 1,
    "street": "sample string 6",
    "apartment_num": "sample string 7",
    "azip": "sample string 8",
    "home": 1,
    "entrance": "sample string 9",
    "p_o_b": 1,
    "insur_code": 1,
    "email": "sample string 10",
    "homephone": "sample string 11",
    "mobilephone": "sample string 12",
    "fax": "sample string 13",
    "workphone": "sample string 14",
    "escort_phone": "sample string 15",
    "sensitivity": "sample string 16",
    "smoker": "sample string 17",
    "elevator": "sample string 18",
    "MobileOrEmail": "sample string 19",
    "get_reminder_sms": true,
    "mailing": true,
    "RecaptchaResponse": "sample string 22"
  },
  "PatAppointments": [
    {
      "dline": 1,
      "diary_num": 2,
      "mark": "sample string 3",
      "status": "sample string 4",
      "date": "2026-01-23T17:52:18.2745189+02:00",
      "time": "00:00:00.1234567",
      "rem": "sample string 7",
      "diary_name": "sample string 8",
      "cust_num": 9,
      "fulldate": "2026-01-23T17:52:18.2745189+02:00",
      "opername": "sample string 11",
      "done": "sample string 12",
      "Instruction": "sample string 13",
      "FileName": "sample string 14",
      "fsurgCode": 1,
      "insureCode": 15,
      "operCode": 16,
      "fsurgName": "sample string 17",
      "patDef": "sample string 18"
    },
    {
      "dline": 1,
      "diary_num": 2,
      "mark": "sample string 3",
      "status": "sample string 4",
      "date": "2026-01-23T17:52:18.2745189+02:00",
      "time": "00:00:00.1234567",
      "rem": "sample string 7",
      "diary_name": "sample string 8",
      "cust_num": 9,
      "fulldate": "2026-01-23T17:52:18.2745189+02:00",
      "opername": "sample string 11",
      "done": "sample string 12",
      "Instruction": "sample string 13",
      "FileName": "sample string 14",
      "fsurgCode": 1,
      "insureCode": 15,
      "operCode": 16,
      "fsurgName": "sample string 17",
      "patDef": "sample string 18"
    }
  ],
  "Version": "sample string 1",
  "AddPatient": "sample string 2",
  "ExpireDate": "2026-01-23T17:52:18.2745189+02:00",
  "Token": "sample string 4",
  "DropConnKey": "sample string 5",
  "SessionId": "sample string 6",
  "MaxFutureAppontments": 7,
  "SmsConfirm": true
}

application/xml, text/xml

Sample: 
<ConnDataForPatient xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BLMedical.MedInterfaces">
  <AddPatient>sample string 2</AddPatient>
  <DropConnKey>sample string 5</DropConnKey>
  <ExpireDate>2026-01-23T17:52:18.2745189+02:00</ExpireDate>
  <MaxFutureAppontments>7</MaxFutureAppontments>
  <PatAppointments>
    <PatientAppointmentExternal>
      <FileName>sample string 14</FileName>
      <Instruction>sample string 13</Instruction>
      <cust_num>9</cust_num>
      <date>2026-01-23T17:52:18.2745189+02:00</date>
      <diary_name>sample string 8</diary_name>
      <diary_num>2</diary_num>
      <dline>1</dline>
      <done>sample string 12</done>
      <fsurgCode>1</fsurgCode>
      <fsurgName>sample string 17</fsurgName>
      <fulldate>2026-01-23T17:52:18.2745189+02:00</fulldate>
      <insureCode>15</insureCode>
      <mark>sample string 3</mark>
      <operCode>16</operCode>
      <opername>sample string 11</opername>
      <patDef>sample string 18</patDef>
      <rem>sample string 7</rem>
      <status>sample string 4</status>
      <time>PT0.1234567S</time>
    </PatientAppointmentExternal>
    <PatientAppointmentExternal>
      <FileName>sample string 14</FileName>
      <Instruction>sample string 13</Instruction>
      <cust_num>9</cust_num>
      <date>2026-01-23T17:52:18.2745189+02:00</date>
      <diary_name>sample string 8</diary_name>
      <diary_num>2</diary_num>
      <dline>1</dline>
      <done>sample string 12</done>
      <fsurgCode>1</fsurgCode>
      <fsurgName>sample string 17</fsurgName>
      <fulldate>2026-01-23T17:52:18.2745189+02:00</fulldate>
      <insureCode>15</insureCode>
      <mark>sample string 3</mark>
      <operCode>16</operCode>
      <opername>sample string 11</opername>
      <patDef>sample string 18</patDef>
      <rem>sample string 7</rem>
      <status>sample string 4</status>
      <time>PT0.1234567S</time>
    </PatientAppointmentExternal>
  </PatAppointments>
  <PatData>
    <MobileOrEmail>sample string 19</MobileOrEmail>
    <RecaptchaResponse>sample string 22</RecaptchaResponse>
    <apartment_num>sample string 7</apartment_num>
    <azip>sample string 8</azip>
    <born>2026-01-23T17:52:18.2745189+02:00</born>
    <city_code>1</city_code>
    <cust_num>1</cust_num>
    <elevator>sample string 18</elevator>
    <email>sample string 10</email>
    <entrance>sample string 9</entrance>
    <escort_phone>sample string 15</escort_phone>
    <fax>sample string 13</fax>
    <first_name>sample string 4</first_name>
    <get_reminder_sms>true</get_reminder_sms>
    <home>1</home>
    <homephone>sample string 11</homephone>
    <id_num>sample string 1</id_num>
    <insur_code>1</insur_code>
    <last_name>sample string 3</last_name>
    <mailing>true</mailing>
    <mobilephone>sample string 12</mobilephone>
    <p_o_b>1</p_o_b>
    <pasport>sample string 2</pasport>
    <sensitivity>sample string 16</sensitivity>
    <sex>sample string 5</sex>
    <smoker>sample string 17</smoker>
    <street>sample string 6</street>
    <workphone>sample string 14</workphone>
  </PatData>
  <SessionId>sample string 6</SessionId>
  <SmsConfirm>true</SmsConfirm>
  <Token>sample string 4</Token>
  <Version>sample string 1</Version>
</ConnDataForPatient>

application/bson

Sample: 
Binary JSON content. See http://bsonspec.org for details.