POST Api/Login/Login

Request Information

URI Parameters

None.

Body Parameters

LoginParametersModel
NameDescriptionTypeAdditional information
AcademyId

string

None.

AddLog

boolean

None.

UserType

byte

None.

UserName

string

None.

Password

string

None.

CodedPassword

string

None.

Request Formats

application/json, text/json

Sample:
{
  "AcademyId": "sample string 1",
  "AddLog": true,
  "UserType": 64,
  "UserName": "sample string 4",
  "Password": "sample string 5",
  "CodedPassword": "sample string 6"
}

application/xml, text/xml

Sample:
<LoginParametersModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Api.NovinSchool.com.Models.Parameters">
  <AcademyId>sample string 1</AcademyId>
  <AddLog>true</AddLog>
  <CodedPassword>sample string 6</CodedPassword>
  <Password>sample string 5</Password>
  <UserName>sample string 4</UserName>
  <UserType>64</UserType>
</LoginParametersModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

LoginResponseModel
NameDescriptionTypeAdditional information
User

UserResponseModel

None.

SchoolName

string

None.

CodedPassword

string

None.

LogoUrl

string

None.

OpenCafeBazzar

boolean

None.

Success

boolean

None.

Message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "User": {
    "CodedId": "sample string 1",
    "FullName": "sample string 2",
    "HasPic": true,
    "Success": true,
    "Message": "sample string 5"
  },
  "SchoolName": "sample string 1",
  "CodedPassword": "sample string 2",
  "LogoUrl": "sample string 3",
  "OpenCafeBazzar": true,
  "Success": true,
  "Message": "sample string 6"
}

application/xml, text/xml

Sample:
<LoginResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Api.NovinSchool.com.Models.Response">
  <Message>sample string 6</Message>
  <Success>true</Success>
  <CodedPassword>sample string 2</CodedPassword>
  <LogoUrl>sample string 3</LogoUrl>
  <OpenCafeBazzar>true</OpenCafeBazzar>
  <SchoolName>sample string 1</SchoolName>
  <User>
    <Message>sample string 5</Message>
    <Success>true</Success>
    <CodedId>sample string 1</CodedId>
    <FullName>sample string 2</FullName>
    <HasPic>true</HasPic>
  </User>
</LoginResponseModel>