POST Security/Login

Request Information

URI Parameters

None.

Body Parameters

SecurityTokenRequest
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:
<SecurityTokenRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/api.oneplan.co.za.Models">
  <Password>sample string 2</Password>
  <Username>sample string 1</Username>
</SecurityTokenRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseOfSecurityTokenVerified
NameDescriptionTypeAdditional information
Success

boolean

None.

Message

string

None.

Entity

SecurityTokenVerified

None.

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "Message": "sample string 2",
  "Entity": {
    "SecurityKey": "sample string 1",
    "UserType": "sample string 2"
  }
}

application/xml, text/xml

Sample:
<ResponseOfSecurityTokenVerifiedlP_S41WJs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnePlan.Core">
  <Entity xmlns:d2p1="http://schemas.datacontract.org/2004/07/api.oneplan.co.za.Models">
    <d2p1:SecurityKey>sample string 1</d2p1:SecurityKey>
    <d2p1:UserType>sample string 2</d2p1:UserType>
  </Entity>
  <Message>sample string 2</Message>
  <Success>true</Success>
</ResponseOfSecurityTokenVerifiedlP_S41WJs>