POST ProviderComm/LoginCompany/{SystemLanguageId}

Login. It will return SecurityToken, which is required to be set as the header value VOYCEToken for subsequent calls.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
SystemLanguageId

integer

Required

Body Parameters

ParaLoginInfoCompany
NameDescriptionTypeAdditional information
Email

string

None.
Password

string

None.
CompanyId

integer

None.
CompanyCode

string

None.
AppType

string

None.
DeviceType

string

None.
CurVersion

string

None.
ParentCompanyCode

string

None.
IOSSerialNumber

string

None.
SerialNumber

string

None.

Request Formats

application/json, text/json

Sample: 
{
  "Email": "sample string 1",
  "Password": "sample string 2",
  "CompanyId": 3,
  "CompanyCode": "sample string 4",
  "AppType": "sample string 5",
  "DeviceType": "sample string 6",
  "CurVersion": "sample string 7",
  "ParentCompanyCode": "sample string 8",
  "IOSSerialNumber": "sample string 9",
  "SerialNumber": "sample string 10"
}

application/xml, text/xml

Sample: 
<ParaLoginInfoCompany xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models">
  <AppType>sample string 5</AppType>
  <CompanyCode>sample string 4</CompanyCode>
  <CompanyId>3</CompanyId>
  <CurVersion>sample string 7</CurVersion>
  <DeviceType>sample string 6</DeviceType>
  <Email>sample string 1</Email>
  <IOSSerialNumber>sample string 9</IOSSerialNumber>
  <ParentCompanyCode>sample string 8</ParentCompanyCode>
  <Password>sample string 2</Password>
  <SerialNumber>sample string 10</SerialNumber>
</ParaLoginInfoCompany>

Response Information

Resource Description

SecurityToken

ParaSecurityToken
NameDescriptionTypeAdditional 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>