POST api/login/login

Login

Request Information

URI Parameters

None.

Body Parameters

Model with all the necessary parameters encrypted in base64

Login
NameDescriptionTypeAdditional information
User

User encrypted in base64

string

Required

Password

Password encrypted in base64

string

Required

Data type: Password

Request Formats

application/json, text/json

Sample:
{
  "User": "sample string 1",
  "Password": "sample string 2"
}

application/xml, text/xml

Sample:
<Login xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FMS.Api.Models">
  <Password>sample string 2</Password>
  <User>sample string 1</User>
</Login>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

JSON with next parameters: EventNumber, Success, Message and UserData.

LoginResponse
NameDescriptionTypeAdditional information
EventNumber

EventNumber: 0 Failed, 1 User or Password missing, 2 Inactive User, 3 Email Confirmed, 4 Login confirmed

integer

None.

Success

A flag indicating whether the request was successful

boolean

None.

Message

A descriptive message

string

None.

UserData

All data from User

UserDataResponse

None.

Response Formats

application/json, text/json

Sample:
{
  "EventNumber": 1,
  "Success": true,
  "Message": "sample string 3",
  "UserData": {
    "UserID": "d31cdf0d-e604-40b4-9007-35fdc80997a7",
    "Email": "sample string 2",
    "UserName": "sample string 3",
    "CPF": "sample string 4",
    "Enrollment": "sample string 5",
    "DescriptionRank": "sample string 6",
    "DescriptionRankGroup": "sample string 7",
    "Name": "sample string 8",
    "Active": true,
    "Departament": "sample string 10",
    "Profile": "sample string 11"
  }
}

application/xml, text/xml

Sample:
<LoginResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FMS.Api.Models">
  <EventNumber>1</EventNumber>
  <Message>sample string 3</Message>
  <Success>true</Success>
  <UserData>
    <Active>true</Active>
    <CPF>sample string 4</CPF>
    <Departament>sample string 10</Departament>
    <DescriptionRank>sample string 6</DescriptionRank>
    <DescriptionRankGroup>sample string 7</DescriptionRankGroup>
    <Email>sample string 2</Email>
    <Enrollment>sample string 5</Enrollment>
    <Name>sample string 8</Name>
    <Profile>sample string 11</Profile>
    <UserID>d31cdf0d-e604-40b4-9007-35fdc80997a7</UserID>
    <UserName>sample string 3</UserName>
  </UserData>
</LoginResponse>