POST api/sysauth/token

Admin the specified token.

Request Information

URI Parameters

None.

Body Parameters

The token.

Systemic.Model.Common.mlAuth+TokenRequest
NamedescriptionTypeAdditional information
AuthType

string

Required
UserName

string

Required
Password

string

Required
CompanyID

string

Required
Client

string

Required
Agent

string

Required
IP

string

None.
DevKey

string

Required
DevToken

string

Required

Request Formats

application/json, text/json, text/html

Sample: 
{
  "AuthType": "sample string 1",
  "UserName": "sample string 2",
  "Password": "sample string 3",
  "CompanyID": "sample string 4",
  "Client": "sample string 5",
  "Agent": "sample string 6",
  "IP": "sample string 7",
  "DevKey": "sample string 8",
  "DevToken": "sample string 9"
}

text/xml

Sample: 
<mlAuth.TokenRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Systemic.Model.Common">
  <Agent>sample string 6</Agent>
  <AuthType>sample string 1</AuthType>
  <Client>sample string 5</Client>
  <CompanyID>sample string 4</CompanyID>
  <DevKey>sample string 8</DevKey>
  <DevToken>sample string 9</DevToken>
  <IP>sample string 7</IP>
  <Password>sample string 3</Password>
  <UserName>sample string 2</UserName>
</mlAuth.TokenRequest>

response Information

Resource description

System.String.

Systemic.Model.Common.mlAuthData
NamedescriptionTypeAdditional information
access_token

string

None.
refresh_token

string

None.
token_type

string

None.
expiration_time

string

None.
Profile

Systemic.Model.Common.mlUser

None.
School

Systemic.Model.Common.mlSchool

None.
lstMenu

Collection of Systemic.Model.Admin.Menu.mlMenuAction+MenuActionInfo

None.

response Formats

application/json, text/json, text/html

Sample: 
{
  "access_token": "sample string 1",
  "refresh_token": "sample string 2",
  "token_type": "sample string 3",
  "expiration_time": "sample string 4",
  "Profile": {
    "SysId": 1,
    "FullName": "sample string 2",
    "Username": "sample string 3",
    "Userimage": "sample string 4",
    "Role": {
      "SysId": 1,
      "Id": "sample string 2",
      "Name": "sample string 3"
    },
    "Company": {
      "Branch": {
        "SysId": 1,
        "Name": "sample string 2",
        "Logo": "sample string 3"
      },
      "SysId": 1,
      "Id": "sample string 2",
      "Name": "sample string 3"
    }
  },
  "School": {
    "AccountYear": {
      "AccountYearSysID": 1,
      "AccountYearID": "sample string 2",
      "StartDate": "sample string 3",
      "EndDate": "sample string 4"
    },
    "CurrentAcademicYear": {
      "AcademicYearSysId": 1,
      "AcademicYearID": "sample string 2",
      "StartDate": "sample string 3",
      "EndDate": "sample string 4",
      "BranchSysID": 5
    },
    "ActiveAcademicYear": {
      "AcademicYearSysId": 1,
      "AcademicYearID": "sample string 2",
      "StartDate": "sample string 3",
      "EndDate": "sample string 4",
      "BranchSysID": 5
    }
  },
  "lstMenu": [
    {
      "MenuSysID": 1,
      "Name": "sample string 2",
      "Icon": "sample string 3",
      "ParentSysID": 4,
      "ParentMenuName": "sample string 5",
      "Url": "sample string 6",
      "SortOrder": 7,
      "IsAllowSubMenu": true,
      "IsSuperAdminMenu": true,
      "IsAction": true,
      "IsMapped": true,
      "SpecialValue": "sample string 12"
    },
    {
      "MenuSysID": 1,
      "Name": "sample string 2",
      "Icon": "sample string 3",
      "ParentSysID": 4,
      "ParentMenuName": "sample string 5",
      "Url": "sample string 6",
      "SortOrder": 7,
      "IsAllowSubMenu": true,
      "IsSuperAdminMenu": true,
      "IsAction": true,
      "IsMapped": true,
      "SpecialValue": "sample string 12"
    }
  ]
}

text/xml

Sample: 
<mlAuthData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Systemic.Model.Common">
  <Profile>
    <Company>
      <Id>sample string 2</Id>
      <Name>sample string 3</Name>
      <SysId>1</SysId>
      <Branch>
        <Logo>sample string 3</Logo>
        <Name>sample string 2</Name>
        <SysId>1</SysId>
      </Branch>
    </Company>
    <FullName>sample string 2</FullName>
    <Role>
      <Id>sample string 2</Id>
      <Name>sample string 3</Name>
      <SysId>1</SysId>
    </Role>
    <SysId>1</SysId>
    <Userimage>sample string 4</Userimage>
    <Username>sample string 3</Username>
  </Profile>
  <School>
    <AccountYear xmlns="http://schemas.datacontract.org/2004/07/Systemic.Model.Account">
      <AccountYearID>sample string 2</AccountYearID>
      <AccountYearSysID>1</AccountYearSysID>
      <EndDate>sample string 4</EndDate>
      <StartDate>sample string 3</StartDate>
    </AccountYear>
    <ActiveAcademicYear xmlns="http://schemas.datacontract.org/2004/07/Systemic.Model.Account">
      <AcademicYearID>sample string 2</AcademicYearID>
      <AcademicYearSysId>1</AcademicYearSysId>
      <BranchSysID>5</BranchSysID>
      <EndDate>sample string 4</EndDate>
      <StartDate>sample string 3</StartDate>
    </ActiveAcademicYear>
    <CurrentAcademicYear xmlns="http://schemas.datacontract.org/2004/07/Systemic.Model.Account">
      <AcademicYearID>sample string 2</AcademicYearID>
      <AcademicYearSysId>1</AcademicYearSysId>
      <BranchSysID>5</BranchSysID>
      <EndDate>sample string 4</EndDate>
      <StartDate>sample string 3</StartDate>
    </CurrentAcademicYear>
  </School>
  <access_token>sample string 1</access_token>
  <expiration_time>sample string 4</expiration_time>
  <lstMenu xmlns:d2p1="http://schemas.datacontract.org/2004/07/Systemic.Model.Admin.Menu">
    <d2p1:mlMenuAction.MenuActionInfo>
      <d2p1:Icon>sample string 3</d2p1:Icon>
      <d2p1:IsAction>true</d2p1:IsAction>
      <d2p1:IsAllowSubMenu>true</d2p1:IsAllowSubMenu>
      <d2p1:IsMapped>true</d2p1:IsMapped>
      <d2p1:IsSuperAdminMenu>true</d2p1:IsSuperAdminMenu>
      <d2p1:MenuSysID>1</d2p1:MenuSysID>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:ParentMenuName>sample string 5</d2p1:ParentMenuName>
      <d2p1:ParentSysID>4</d2p1:ParentSysID>
      <d2p1:SortOrder>7</d2p1:SortOrder>
      <d2p1:SpecialValue>sample string 12</d2p1:SpecialValue>
      <d2p1:Url>sample string 6</d2p1:Url>
    </d2p1:mlMenuAction.MenuActionInfo>
    <d2p1:mlMenuAction.MenuActionInfo>
      <d2p1:Icon>sample string 3</d2p1:Icon>
      <d2p1:IsAction>true</d2p1:IsAction>
      <d2p1:IsAllowSubMenu>true</d2p1:IsAllowSubMenu>
      <d2p1:IsMapped>true</d2p1:IsMapped>
      <d2p1:IsSuperAdminMenu>true</d2p1:IsSuperAdminMenu>
      <d2p1:MenuSysID>1</d2p1:MenuSysID>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:ParentMenuName>sample string 5</d2p1:ParentMenuName>
      <d2p1:ParentSysID>4</d2p1:ParentSysID>
      <d2p1:SortOrder>7</d2p1:SortOrder>
      <d2p1:SpecialValue>sample string 12</d2p1:SpecialValue>
      <d2p1:Url>sample string 6</d2p1:Url>
    </d2p1:mlMenuAction.MenuActionInfo>
  </lstMenu>
  <refresh_token>sample string 2</refresh_token>
  <token_type>sample string 3</token_type>
</mlAuthData>