POST api/authenticate

Serves credentials, that can be used to access VobeSoft, upon succesful authentication.



Request Information

URI Parameters

None.



Body Parameters

The authentication values, send by the user, to validate.

AuthenticationViewModel
NameDescriptionTypeAdditional information
UserName

string

None.

Password

string

None.

Request Formats

application/json, text/json

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

application/xml, text/xml

Sample:
<AuthenticationViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VobeSoft.Models.ViewModels">
  <Password>sample string 2</Password>
  <UserName>sample string 1</UserName>
</AuthenticationViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.



Response Information

Resource Description

Credentials for accessing VobeSoft, if the user is successfully authenticated; an HTTP 403 exception, otherwise.

CredentialsViewModel

NameDescriptionTypeAdditional information
AuthenticationToken

globally unique identifier

None.

IsLockedOut

boolean

None.

IsValid

boolean

None.

RemainingLockedOutSeconds

decimal number

None.

UserCompanyId

integer

None.

UserId

globally unique identifier

None.

UserName

string

None.

VobeSoftAuthenticationTicket

string

None.

VobeSoftSessionId

string

None.

Response Formats

application/json, text/json

Sample:
{
  "AuthenticationToken": "967d4a6e-2b8d-45af-ba0b-80d23b72cbbf",
  "IsLockedOut": true,
  "IsValid": true,
  "RemainingLockedOutSeconds": 4.1,
  "UserCompanyId": 5,
  "UserId": "45a8699f-49f4-4bbf-89cb-d825cf5e7f91",
  "UserName": "sample string 7",
  "VobeSoftAuthenticationTicket": "sample string 8",
  "VobeSoftSessionId": "sample string 9"
}

application/xml, text/xml

Sample:
<CredentialsViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VobeSoft.Models.ViewModels">
  <AuthenticationToken>967d4a6e-2b8d-45af-ba0b-80d23b72cbbf</AuthenticationToken>
  <IsLockedOut>true</IsLockedOut>
  <IsValid>true</IsValid>
  <RemainingLockedOutSeconds>4.1</RemainingLockedOutSeconds>
  <UserCompanyId>5</UserCompanyId>
  <UserId>45a8699f-49f4-4bbf-89cb-d825cf5e7f91</UserId>
  <UserName>sample string 7</UserName>
  <VobeSoftAuthenticationTicket>sample string 8</VobeSoftAuthenticationTicket>
  <VobeSoftSessionId>sample string 9</VobeSoftSessionId>
</CredentialsViewModel>