POST api/Login

Request Information

URI Parameters

None.

Body Parameters

LoginRequest
NameDescriptionTypeAdditional information
UserName

string

Required

Password

string

Required

Request Formats

application/json, text/json

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

application/xml, text/xml

Sample:
<LoginRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Entities.Account">
  <Password>sample string 2</Password>
  <UserName>sample string 1</UserName>
</LoginRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'LoginRequest'.

Response Information

Resource Description

ApiSuccessOfLoginResult
NameDescriptionTypeAdditional information
Success

boolean
Data

LoginResult

Response Formats

application/json

Sample:
{
  "Success": true,
  "Data": {
    "SessionKey": "n1Ry2VkpKtZo3+fFa5zTz8vWch1KxQ+wzc6qwy/sjV81AJUH9qDvKkdR4YFSCQkIYEqCk1BgXJwFl6QST2sVuEXqNeILnZwIgiYCgcGMX9Y=",
    "LoggedIn": true
  }
}

text/json

Sample:
{
  "Success": true,
  "Data": {
    "SessionKey": "nPcUtBe73/QgVdApTRDfi0Sz4F33XCKZnzzL39dSJOHgbwVNBqTClAVJnivyoKIxEMeUAn0arauANWZ4Q++vu2ATORiUQDwTyS3ZL2Vist4=",
    "LoggedIn": true
  }
}

application/xml, text/xml

Sample:
<ApiSuccessOfLoginResultgLC8bFpX xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Api">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Entities.Account">
    <d2p1:LoggedIn>true</d2p1:LoggedIn>
    <d2p1:SessionKey>sample string 1</d2p1:SessionKey>
  </Data>
</ApiSuccessOfLoginResultgLC8bFpX>