POST api/hps/Login

Request Information

URI Parameters

None.

Body Parameters

LoginRequest
NameDescriptionTypeAdditional information
Username

string

None.

Password

string

None.

UserType

string

None.

Compnyid

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Username": "sample string 1",
  "Password": "sample string 2",
  "UserType": "sample string 3",
  "Compnyid": "sample string 4"
}

application/xml, text/xml

Sample:
<LoginRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Result.ResultModel">
  <Compnyid>sample string 4</Compnyid>
  <Password>sample string 2</Password>
  <UserType>sample string 3</UserType>
  <Username>sample string 1</Username>
</LoginRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

LoginResponse
NameDescriptionTypeAdditional information
IsSuccess

boolean

None.

usertype

integer

None.

Patient

WebResult_PatientLogin_Result

None.

Clinic

WebResult_ClinicLogin_Result

None.

Doctor

WebResult_DoctorLogin_Result

None.

Payer

WebResult_PayerLogin_Result

None.

Response Formats

application/json, text/json

Sample:
{
  "IsSuccess": true,
  "usertype": 2,
  "Patient": {
    "ID": "sample string 1",
    "Name": "sample string 2",
    "Gender": "sample string 3",
    "DOB": "2026-06-08T11:08:12.6018053+02:00",
    "Mobile": "sample string 5",
    "Phone": "sample string 6",
    "Email": "sample string 7",
    "Address": "sample string 8",
    "NationalID": 1,
    "Photo": "QEA="
  },
  "Clinic": {
    "ID": 1,
    "Name": "sample string 2",
    "Phone": "sample string 3",
    "Email": "sample string 4",
    "Address": "sample string 5",
    "DoctorInCharge": "sample string 6",
    "Speciality": "sample string 7"
  },
  "Doctor": {
    "ID": 1,
    "Name": "sample string 2",
    "Phone": "sample string 3",
    "Email": "sample string 4",
    "Address": "sample string 5",
    "Speciality": "sample string 6"
  },
  "Payer": {
    "ID": 1,
    "Name": "sample string 2",
    "Mobile": "sample string 3",
    "Phone": "sample string 4",
    "Email": "sample string 5",
    "Address": "sample string 6",
    "InCharge": "sample string 7"
  }
}

application/xml, text/xml

Sample:
<LoginResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Result.ResultModel">
  <Clinic xmlns:d2p1="http://schemas.datacontract.org/2004/07/Result.DAL">
    <d2p1:Address>sample string 5</d2p1:Address>
    <d2p1:DoctorInCharge>sample string 6</d2p1:DoctorInCharge>
    <d2p1:Email>sample string 4</d2p1:Email>
    <d2p1:ID>1</d2p1:ID>
    <d2p1:Name>sample string 2</d2p1:Name>
    <d2p1:Phone>sample string 3</d2p1:Phone>
    <d2p1:Speciality>sample string 7</d2p1:Speciality>
  </Clinic>
  <Doctor xmlns:d2p1="http://schemas.datacontract.org/2004/07/Result.DAL">
    <d2p1:Address>sample string 5</d2p1:Address>
    <d2p1:Email>sample string 4</d2p1:Email>
    <d2p1:ID>1</d2p1:ID>
    <d2p1:Name>sample string 2</d2p1:Name>
    <d2p1:Phone>sample string 3</d2p1:Phone>
    <d2p1:Speciality>sample string 6</d2p1:Speciality>
  </Doctor>
  <IsSuccess>true</IsSuccess>
  <Patient xmlns:d2p1="http://schemas.datacontract.org/2004/07/Result.DAL">
    <d2p1:Address>sample string 8</d2p1:Address>
    <d2p1:DOB>2026-06-08T11:08:12.6018053+02:00</d2p1:DOB>
    <d2p1:Email>sample string 7</d2p1:Email>
    <d2p1:Gender>sample string 3</d2p1:Gender>
    <d2p1:ID>sample string 1</d2p1:ID>
    <d2p1:Mobile>sample string 5</d2p1:Mobile>
    <d2p1:Name>sample string 2</d2p1:Name>
    <d2p1:NationalID>1</d2p1:NationalID>
    <d2p1:Phone>sample string 6</d2p1:Phone>
    <d2p1:Photo>QEA=</d2p1:Photo>
  </Patient>
  <Payer xmlns:d2p1="http://schemas.datacontract.org/2004/07/Result.DAL">
    <d2p1:Address>sample string 6</d2p1:Address>
    <d2p1:Email>sample string 5</d2p1:Email>
    <d2p1:ID>1</d2p1:ID>
    <d2p1:InCharge>sample string 7</d2p1:InCharge>
    <d2p1:Mobile>sample string 3</d2p1:Mobile>
    <d2p1:Name>sample string 2</d2p1:Name>
    <d2p1:Phone>sample string 4</d2p1:Phone>
  </Payer>
  <usertype>2</usertype>
</LoginResponse>