POST Provider/LoginBySAMLToken/{SystemLanguageId}

Login by SAML Token (SAML Single Sign On). Web Use Only It will return SecurityToken, which is required to be set as the header value WEYIToken for subsequent calls.

Request Information

URI Parameters

Name	Description	Type	Additional information
SystemLanguageId		integer	Required

Body Parameters

ParaLoginInfoCompanyByToken

Name	Type	Additional information
Token	string	None.
CompanyId	integer	None.
CompanyCode	string	None.
AppType	string	None.
DeviceType	string	None.
CurVersion	string	None.
SerialNumber	string	None.
UrlParams	string	None.

Request Formats

application/json, text/json

Sample:

{
  "Token": "sample string 1",
  "CompanyId": 2,
  "CompanyCode": "sample string 3",
  "AppType": "sample string 4",
  "DeviceType": "sample string 5",
  "CurVersion": "sample string 6",
  "SerialNumber": "sample string 7",
  "UrlParams": "sample string 8"
}

application/xml, text/xml

Sample:

<ParaLoginInfoCompanyByToken xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models">
  <AppType>sample string 4</AppType>
  <CompanyCode>sample string 3</CompanyCode>
  <CompanyId>2</CompanyId>
  <CurVersion>sample string 6</CurVersion>
  <DeviceType>sample string 5</DeviceType>
  <SerialNumber>sample string 7</SerialNumber>
  <Token>sample string 1</Token>
  <UrlParams>sample string 8</UrlParams>
</ParaLoginInfoCompanyByToken>

Response Information

Resource Description

SecurityToken

ParaSecurityToken

Name	Type	Additional information
GlobalServerId	integer	None.
Id	integer	None.
Token	string	None.
NewURL	string	None.
NotificationServerIP	string	None.
WebPageLoginInfo	ResultWebLoginPage	None.
AgreementUrl	string	None.
NotificationServerPort	string	None.
SupportScheduleTask	boolean	None.
SupportClientPreselectionSchedule	boolean	None.
CompanyId	integer	None.
CompanyCode	string	None.

Response Formats

application/json, text/json

Sample:

{
  "GlobalServerId": 1,
  "Id": 1,
  "Token": "sample string 1",
  "NewURL": "sample string 2",
  "NotificationServerIP": "sample string 3",
  "WebPageLoginInfo": {
    "URL": "sample string 1",
    "WebKey": "sample string 2"
  },
  "AgreementUrl": "sample string 4",
  "NotificationServerPort": "sample string 5",
  "SupportScheduleTask": true,
  "SupportClientPreselectionSchedule": true,
  "CompanyId": 1,
  "CompanyCode": "sample string 6"
}

application/xml, text/xml

Sample:

<ParaSecurityToken xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models">
  <AgreementUrl>sample string 4</AgreementUrl>
  <CompanyCode>sample string 6</CompanyCode>
  <CompanyId>1</CompanyId>
  <GlobalServerId>1</GlobalServerId>
  <Id>1</Id>
  <NewURL>sample string 2</NewURL>
  <NotificationServerIP>sample string 3</NotificationServerIP>
  <NotificationServerPort>sample string 5</NotificationServerPort>
  <SupportClientPreselectionSchedule>true</SupportClientPreselectionSchedule>
  <SupportScheduleTask>true</SupportScheduleTask>
  <Token>sample string 1</Token>
  <WebPageLoginInfo>
    <URL>sample string 1</URL>
    <WebKey>sample string 2</WebKey>
  </WebPageLoginInfo>
</ParaSecurityToken>