POST Users/ValidateLogin

Validates the login information provided

Request Information

URI Parameters

None.

Body Parameters

The Login and password object

LoginDTO
NameDescriptionTypeAdditional information
UserName

The Name of the user

string

None.

Password

Password

string

None.

RememberMe

Gets or sets the indicator to specify if RememberMe is selected

boolean

None.

IPAddress

The IP Address of the User

string

None.

Enviorment

The Enviorment the Action Came from

string

None.

Request Formats

application/json, text/json

Sample:
{
  "results": [
    {
      "UserName": "sample string 1",
      "Password": "sample string 2",
      "RememberMe": true,
      "IPAddress": "sample string 4",
      "Enviorment": "sample string 5"
    }
  ]
}

text/javascript

Sample:
{"results":[{"UserName":"sample string 1","Password":"sample string 2","RememberMe":true,"IPAddress":"sample string 4","Enviorment":"sample string 5"}]}

application/bson

Sample:
Binary JSON content. See http://bsonspec.org for details.

application/xml, text/xml

Sample:
<LoginDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Lpp.Dns.DTO">
  <Enviorment>sample string 5</Enviorment>
  <IPAddress>sample string 4</IPAddress>
  <Password>sample string 2</Password>
  <RememberMe>true</RememberMe>
  <UserName>sample string 1</UserName>
</LoginDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The User that logged in if valid login or password. Error codes if fail

UserDTO
NameDescriptionTypeAdditional information
UserName

Gets or sets the UserName of the User.

string

None.

Title

Gets or sets the Title of the User.

string

None.

FirstName

Gets or sets the First Name of the User.

string

None.

LastName

Gets or sets the Last Name of the User.

string

None.

MiddleName

Gets or sets the Middle Name of the User.

string

None.

Phone

Gets or sets the Phone Number of the User.

string

None.

Fax

Gets or sets the Fax Number of the User.

string

None.

Email

Gets or sets the Email of the User.

string

None.

Active

Gets or sets if the User is Active.

boolean

None.

Deleted

Gets or sets if the User is Deleted.

boolean

None.

OrganizationID

Gets or sets the Identifier of the Organization the User belongs to.

globally unique identifier

None.

Organization

Gets or sets the Name of the Organization the User belongs to.

string

None.

OrganizationRequested

Gets or sets the Organization the User requested during Registration.

string

None.

RoleID

Gets or sets the Identifier of the Role of the User.

globally unique identifier

None.

RoleRequested

Gets or sets the Role the User requested during Registration.

string

None.

SignedUpOn

Gets or sets the Date the user registered on.

date

None.

ActivatedOn

Gets or sets the date the user was Activated on.

date

None.

DeactivatedOn

Gets or sets the date the user was Deactivated on.

date

None.

DeactivatedByID

Gets or sets the Identifier of the User who deactivated this User.

globally unique identifier

None.

DeactivatedBy

Gets or sets the name of the user who deactivated this User.

string

None.

DeactivationReason

Gets or sets the reason why the User was deactivated.

string

None.

RejectReason

Gets or sets the reason given that this user was rejected during registration.

string

None.

RejectedOn

Gets or sets the date when this user was rejected.

date

None.

RejectedByID

Gets or sets the Identifier of the User who rejected this User.

globally unique identifier

None.

RejectedBy

Gets or sets the name of the user who rejected this User.

string

None.

ID

globally unique identifier

None.

Timestamp

Collection of byte

None.

Response Formats

application/json, text/json

Sample:
{
  "results": [
    {
      "UserName": "sample string 1",
      "Title": "sample string 2",
      "FirstName": "sample string 3",
      "LastName": "sample string 4",
      "MiddleName": "sample string 5",
      "Phone": "sample string 6",
      "Fax": "sample string 7",
      "Email": "sample string 8",
      "Active": true,
      "Deleted": true,
      "OrganizationID": "89d0ed45-40cd-4a30-a23a-6a00aecaee1e",
      "Organization": "sample string 11",
      "OrganizationRequested": "sample string 12",
      "RoleID": "e65a3c2f-be22-4d33-8ce1-c8fc3691ad81",
      "RoleRequested": "sample string 13",
      "SignedUpOn": "2024-05-14T10:24:55Z",
      "ActivatedOn": "2024-05-14T10:24:55Z",
      "DeactivatedOn": "2024-05-14T10:24:55Z",
      "DeactivatedByID": "cc21ac0e-577c-4c9b-a784-aace4706daf9",
      "DeactivatedBy": "sample string 14",
      "DeactivationReason": "sample string 15",
      "RejectReason": "sample string 16",
      "RejectedOn": "2024-05-14T10:24:55Z",
      "RejectedByID": "8bae800f-e37c-4ab6-9bfc-015c315c4bdb",
      "RejectedBy": "sample string 17",
      "ID": "678579b3-f834-4f0d-9b32-ee01239d6b17",
      "Timestamp": "QEA="
    }
  ]
}

text/javascript

Sample:
{"results":[{"UserName":"sample string 1","Title":"sample string 2","FirstName":"sample string 3","LastName":"sample string 4","MiddleName":"sample string 5","Phone":"sample string 6","Fax":"sample string 7","Email":"sample string 8","Active":true,"Deleted":true,"OrganizationID":"89d0ed45-40cd-4a30-a23a-6a00aecaee1e","Organization":"sample string 11","OrganizationRequested":"sample string 12","RoleID":"e65a3c2f-be22-4d33-8ce1-c8fc3691ad81","RoleRequested":"sample string 13","SignedUpOn":"2024-05-14T10:24:55Z","ActivatedOn":"2024-05-14T10:24:55Z","DeactivatedOn":"2024-05-14T10:24:55Z","DeactivatedByID":"cc21ac0e-577c-4c9b-a784-aace4706daf9","DeactivatedBy":"sample string 14","DeactivationReason":"sample string 15","RejectReason":"sample string 16","RejectedOn":"2024-05-14T10:24:55Z","RejectedByID":"8bae800f-e37c-4ab6-9bfc-015c315c4bdb","RejectedBy":"sample string 17","ID":"678579b3-f834-4f0d-9b32-ee01239d6b17","Timestamp":"QEA="}]}

application/bson

Sample:
Binary JSON content. See http://bsonspec.org for details.

application/xml, text/xml

Sample:
<UserDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Lpp.Dns.DTO">
  <ID xmlns="http://schemas.datacontract.org/2004/07/Lpp.Objects">678579b3-f834-4f0d-9b32-ee01239d6b17</ID>
  <Timestamp xmlns="http://schemas.datacontract.org/2004/07/Lpp.Objects">QEA=</Timestamp>
  <ActivatedOn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2024-05-14T14:24:55.0939048Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>-240</d2p1:OffsetMinutes>
  </ActivatedOn>
  <Active>true</Active>
  <DeactivatedBy>sample string 14</DeactivatedBy>
  <DeactivatedByID>cc21ac0e-577c-4c9b-a784-aace4706daf9</DeactivatedByID>
  <DeactivatedOn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2024-05-14T14:24:55.0939048Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>-240</d2p1:OffsetMinutes>
  </DeactivatedOn>
  <DeactivationReason>sample string 15</DeactivationReason>
  <Deleted>true</Deleted>
  <Email>sample string 8</Email>
  <Fax>sample string 7</Fax>
  <FirstName>sample string 3</FirstName>
  <LastName>sample string 4</LastName>
  <MiddleName>sample string 5</MiddleName>
  <Organization>sample string 11</Organization>
  <OrganizationID>89d0ed45-40cd-4a30-a23a-6a00aecaee1e</OrganizationID>
  <OrganizationRequested>sample string 12</OrganizationRequested>
  <Phone>sample string 6</Phone>
  <RejectReason>sample string 16</RejectReason>
  <RejectedBy>sample string 17</RejectedBy>
  <RejectedByID>8bae800f-e37c-4ab6-9bfc-015c315c4bdb</RejectedByID>
  <RejectedOn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2024-05-14T14:24:55.0939048Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>-240</d2p1:OffsetMinutes>
  </RejectedOn>
  <RoleID>e65a3c2f-be22-4d33-8ce1-c8fc3691ad81</RoleID>
  <RoleRequested>sample string 13</RoleRequested>
  <SignedUpOn xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2024-05-14T14:24:55.0939048Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>-240</d2p1:OffsetMinutes>
  </SignedUpOn>
  <Title>sample string 2</Title>
  <UserName>sample string 1</UserName>
</UserDTO>