GET api/login?email={email}&password={password}&gcmId={gcmId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
email

string

Required

password

string

Required

gcmId

string

Required

Body Parameters

None.

Response Information

Resource Description

LoginResult
NameDescriptionTypeAdditional information
status

string

None.

message

string

None.

users

Collection of LoginPerson

None.

Response Formats

application/json, text/json

Sample:
{
  "status": "sample string 1",
  "message": "sample string 2",
  "users": [
    {
      "PersonID": 1,
      "DistrictID": 1,
      "DistrictName": "sample string 2",
      "RoleName": "sample string 3",
      "SchoolName": "sample string 4",
      "DDLText": "sample string 5",
      "LDAPUserID": "sample string 6"
    },
    {
      "PersonID": 1,
      "DistrictID": 1,
      "DistrictName": "sample string 2",
      "RoleName": "sample string 3",
      "SchoolName": "sample string 4",
      "DDLText": "sample string 5",
      "LDAPUserID": "sample string 6"
    }
  ]
}

application/xml, text/xml

Sample:
<LoginResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessEntities.Account">
  <message>sample string 2</message>
  <status>sample string 1</status>
  <users>
    <LoginPerson>
      <DDLText>sample string 5</DDLText>
      <DistrictID>1</DistrictID>
      <DistrictName>sample string 2</DistrictName>
      <LDAPUserID>sample string 6</LDAPUserID>
      <PersonID>1</PersonID>
      <RoleName>sample string 3</RoleName>
      <SchoolName>sample string 4</SchoolName>
    </LoginPerson>
    <LoginPerson>
      <DDLText>sample string 5</DDLText>
      <DistrictID>1</DistrictID>
      <DistrictName>sample string 2</DistrictName>
      <LDAPUserID>sample string 6</LDAPUserID>
      <PersonID>1</PersonID>
      <RoleName>sample string 3</RoleName>
      <SchoolName>sample string 4</SchoolName>
    </LoginPerson>
  </users>
</LoginResult>