POST api/user/authenticate

Authenticates a user.

Request Information

URI Parameters

None.

Body Parameters

An object with Username and Password properties.

Cyberlogic.eTourism.Mappings.Operations.Dto.Shared.User.AuthenticateUserDTO
NameDescriptionTypeAdditional information
Username

string

None.

Password

string

None.

Request Formats

application/json, text/json

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

text/html

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

application/xml, text/xml

Sample:
<AuthenticateUserDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cyberlogic.eTourism.Mappings.Operations.Dto.Shared.User">
  <Password>sample string 2</Password>
  <Username>sample string 1</Username>
</AuthenticateUserDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

An object with a single boolean property UserAuthenticated.

Cyberlogic.eTourism.Mappings.Operations.Dto.Shared.User.AuthenticateUserResponseDTO
NameDescriptionTypeAdditional information
Id

integer

None.

Name

string

None.

UserAuthenticated

boolean

None.

Roles

Collection of Cyberlogic.eTourism.Domain.ViewModels.Shared.SimpleViewModel

None.

Applications

Collection of Cyberlogic.eTourism.Domain.ViewModels.Shared.SimpleViewModel

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "Name": "sample string 2",
  "UserAuthenticated": true,
  "Roles": [
    {
      "Id": 1,
      "Name": "sample string 2"
    },
    {
      "Id": 1,
      "Name": "sample string 2"
    }
  ],
  "Applications": [
    {
      "Id": 1,
      "Name": "sample string 2"
    },
    {
      "Id": 1,
      "Name": "sample string 2"
    }
  ]
}

text/html

Sample:
{"Id":1,"Name":"sample string 2","UserAuthenticated":true,"Roles":[{"Id":1,"Name":"sample string 2"},{"Id":1,"Name":"sample string 2"}],"Applications":[{"Id":1,"Name":"sample string 2"},{"Id":1,"Name":"sample string 2"}]}

application/xml, text/xml

Sample:
<AuthenticateUserResponseDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cyberlogic.eTourism.Mappings.Operations.Dto.Shared.User">
  <Applications xmlns:d2p1="http://schemas.datacontract.org/2004/07/Cyberlogic.eTourism.Domain.ViewModels.Shared">
    <d2p1:SimpleViewModel>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Name>sample string 2</d2p1:Name>
    </d2p1:SimpleViewModel>
    <d2p1:SimpleViewModel>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Name>sample string 2</d2p1:Name>
    </d2p1:SimpleViewModel>
  </Applications>
  <Id>1</Id>
  <Name>sample string 2</Name>
  <Roles xmlns:d2p1="http://schemas.datacontract.org/2004/07/Cyberlogic.eTourism.Domain.ViewModels.Shared">
    <d2p1:SimpleViewModel>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Name>sample string 2</d2p1:Name>
    </d2p1:SimpleViewModel>
    <d2p1:SimpleViewModel>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Name>sample string 2</d2p1:Name>
    </d2p1:SimpleViewModel>
  </Roles>
  <UserAuthenticated>true</UserAuthenticated>
</AuthenticateUserResponseDTO>