POST api/User/Login

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
EmailId	string	None.
Password	string	None.
LoginType	string	None.
UserToken	string	None.
UserType	integer	None.
deviceInfo	DeviceInfo	None.

Request Formats

application/json, text/json

Sample:

{
  "EmailId": "sample string 1",
  "Password": "sample string 2",
  "LoginType": "sample string 3",
  "UserToken": "sample string 4",
  "UserType": 1,
  "deviceInfo": {
    "RawDeviceId": "sample string 1",
    "State": "sample string 2",
    "CarrierName": "sample string 3",
    "DeviceModel": "sample string 4",
    "DeviceManufacturer": "sample string 5",
    "AppPlatform": "sample string 6",
    "OsVersion": "sample string 7",
    "AppVersionNumber": 1,
    "AppVersion": "sample string 8",
    "DeviceId": "sample string 9",
    "OsName": "sample string 10"
  }
}

application/xml, text/xml

Sample:

<LoginDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOPWAAPI.Model">
  <EmailId>sample string 1</EmailId>
  <LoginType>sample string 3</LoginType>
  <Password>sample string 2</Password>
  <UserToken>sample string 4</UserToken>
  <UserType>1</UserType>
  <deviceInfo>
    <AppPlatform>sample string 6</AppPlatform>
    <AppVersion>sample string 8</AppVersion>
    <AppVersionNumber>1</AppVersionNumber>
    <CarrierName>sample string 3</CarrierName>
    <DeviceId>sample string 9</DeviceId>
    <DeviceManufacturer>sample string 5</DeviceManufacturer>
    <DeviceModel>sample string 4</DeviceModel>
    <OsName>sample string 10</OsName>
    <OsVersion>sample string 7</OsVersion>
    <RawDeviceId>sample string 1</RawDeviceId>
    <State>sample string 2</State>
  </deviceInfo>
</LoginDetails>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'LoginDetails'.

Response Information

Resource Description

VCAPIResponse

Name	Type	Additional information
Version	string	None.
dateTime	string	None.
StatusCode	integer	None.
ErrorMessage	string	None.
Result	Object	None.

Response Formats

application/json, text/json

Sample:

{
  "Version": "1.0.0",
  "dateTime": "2024/09/19 18:15:16",
  "StatusCode": 1,
  "ErrorMessage": "sample string 2",
  "Result": {}
}

application/xml, text/xml

Sample:

<VCAPIResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOPWAAPI.Model">
  <ErrorMessage>sample string 2</ErrorMessage>
  <Result />
  <StatusCode>1</StatusCode>
</VCAPIResponse>