POST api/Account/Login

Logs in the user

Request Information

URI Parameters

None.

Body Parameters

The login model.

LoginModel

Name	Type	Additional information
Email	string	Required Max length: 256
Password	string	Required Data type: Password Max length: 256
Application	Application	Required

Name

Description

Type

Additional information

string

Required

Max length: 256

Password

string

Required

Data type: Password

Max length: 256

Application

Required

Request Formats

application/json, text/json

Sample:

{
  "Email": "sample string 1",
  "Password": "sample string 2",
  "Application": 1
}

application/xml, text/xml

Sample:

<LoginModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOP.Apps.Web.Areas.Api.Models">
  <Application>Web</Application>
  <Email>sample string 1</Email>
  <Password>sample string 2</Password>
</LoginModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ServiceResultOfAuthModel

Name	Type	Additional information
Result	AuthModel	None.
ErrorCode	ServiceErrorCode	None.
ErrorMessage	Collection of string	None.
Success	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "Result": {
    "AuthToken": "sample string 1",
    "Name": "sample string 2",
    "IsCompany": true,
    "CompanyName": "sample string 4",
    "UserRoles": [
      "sample string 1",
      "sample string 2"
    ],
    "EntityState": 1,
    "HasOngoingAuctions": true,
    "HasDeliveries": true,
    "RequiresPasswordChange": true
  },
  "ErrorCode": 0,
  "ErrorMessage": [
    "sample string 1",
    "sample string 2"
  ],
  "Success": true
}

application/xml, text/xml

Sample:

<ServiceResultOfAuthModel_PTu2eKdN xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOP.Common.Infrastructure.ApiObjects.Results">
  <ErrorCode>None</ErrorCode>
  <ErrorMessage xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ErrorMessage>
  <Success>true</Success>
  <Result>
    <AuthToken>sample string 1</AuthToken>
    <CompanyName>sample string 4</CompanyName>
    <EntityState>Pending</EntityState>
    <HasDeliveries>true</HasDeliveries>
    <HasOngoingAuctions>true</HasOngoingAuctions>
    <IsCompany>true</IsCompany>
    <Name>sample string 2</Name>
    <RequiresPasswordChange>true</RequiresPasswordChange>
    <UserRoles xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </UserRoles>
  </Result>
</ServiceResultOfAuthModel_PTu2eKdN>