POST Client/Login/{SystemLanguageId}
Login. 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
ParaLoginInfoName | Description | Type | Additional information |
---|---|---|---|
string |
None. |
||
Password | string |
None. |
|
SupportNewUrl | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{ "Email": "sample string 1", "Password": "sample string 2", "SupportNewUrl": true }
application/xml, text/xml
Sample:
<ParaLoginInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models"> <Email>sample string 1</Email> <Password>sample string 2</Password> <SupportNewUrl>true</SupportNewUrl> </ParaLoginInfo>
Response Information
Resource Description
SecurityToken
ParaSecurityTokenName | Description | 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>