POST Client/RegisterCompany/{SystemLanguageId}

Register Client It will return SecurityToken, which is required to be set as the header value WEYIToken for subsequent calls.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
SystemLanguageId

integer

Required

Body Parameters

ParaPerson
NameDescriptionTypeAdditional information
GlobalServerId

integer

None.

Id

integer

None.

SystemLanguageId

integer

None.

LanguageList

Collection of ParaPersonLanguage

None.

Name

string

None.

Email

string

None.

RegionId

integer

None.

RegionCode

string

None.

RegionShortCode

string

None.

MobilePhone

string

None.

Password

string

None.

FacebookEmail

string

None.

StatusCodeId

integer

None.

Status

string

None.

RegistrationStatusCodeId

integer

None.

TrainStatusCodeId

integer

None.

CountryCode

string

None.

PersonBillingType

integer

None.

PersonServiceStatusCode

integer

None.

PersonMTEnabled

boolean

None.

PersonAnyMeetingEnabled

boolean

None.

NeedAnyMeetingBtnCustomizedName

boolean

None.

AnyMeetingBtnCutomizedName

string

None.

PersonReconnectPopupHoldSecs

integer

None.

CompanyCode

string

None.

isWebApp

boolean

None.

isScheduleEnabled

boolean

None.

GreetingText

string

None.

isVoiceRecognitionEnabled

integer

None.

PersonVoiceRecognitionLanguageMapId

integer

None.

HomePageButtonViewOptionCodeId

integer

None.

HomePageText

string

None.

PatientBtnText

string

None.

InterpreterBtnText

string

None.

AutoClick

boolean

None.

NeedLocationBeforeRequest

boolean

None.

PersonPreLanguageScriptUrl

string

None.

PersonTransactionHistoryEnabled

boolean

None.

CustomizedPauseImageNeeded

boolean

None.

CustomizedPauseImageName

string

None.

CustomizedPauseImageMobileUrl

string

None.

CultureInfo

ParaCultureInfo

None.

EpicInfo

WEYIPersonEpicInfo

None.

Request Formats

application/json, text/json

Sample:
{
  "GlobalServerId": 1,
  "Id": 1,
  "SystemLanguageId": 1,
  "LanguageList": [
    {
      "LanguageId": 1,
      "ProficiencyCodeId": 2
    },
    {
      "LanguageId": 1,
      "ProficiencyCodeId": 2
    }
  ],
  "Name": "sample string 1",
  "Email": "sample string 2",
  "RegionId": 1,
  "RegionCode": "sample string 3",
  "RegionShortCode": "sample string 4",
  "MobilePhone": "sample string 5",
  "Password": "sample string 6",
  "FacebookEmail": "sample string 7",
  "StatusCodeId": 1,
  "Status": "sample string 8",
  "RegistrationStatusCodeId": 1,
  "TrainStatusCodeId": 1,
  "CountryCode": "sample string 9",
  "PersonBillingType": 10,
  "PersonServiceStatusCode": 1,
  "PersonMTEnabled": true,
  "PersonAnyMeetingEnabled": true,
  "NeedAnyMeetingBtnCustomizedName": true,
  "AnyMeetingBtnCutomizedName": "sample string 11",
  "PersonReconnectPopupHoldSecs": 1,
  "CompanyCode": "sample string 12",
  "isWebApp": true,
  "isScheduleEnabled": true,
  "GreetingText": "sample string 13",
  "isVoiceRecognitionEnabled": 1,
  "PersonVoiceRecognitionLanguageMapId": 1,
  "HomePageButtonViewOptionCodeId": 1,
  "HomePageText": "sample string 14",
  "PatientBtnText": "sample string 15",
  "InterpreterBtnText": "sample string 16",
  "AutoClick": true,
  "NeedLocationBeforeRequest": true,
  "PersonPreLanguageScriptUrl": "sample string 17",
  "PersonTransactionHistoryEnabled": true,
  "CustomizedPauseImageNeeded": true,
  "CustomizedPauseImageName": "sample string 18",
  "CustomizedPauseImageMobileUrl": "sample string 19",
  "CultureInfo": {
    "DateDisplay": "sample string 1",
    "TimeDisplay": "sample string 2",
    "DateTimeDisplay": "sample string 3",
    "CurrencyDisplay": "sample string 4"
  },
  "EpicInfo": {
    "PatientName": "sample string 1",
    "EncounterLocation": "sample string 2",
    "Language": "sample string 3",
    "OrgName": "sample string 4"
  }
}

application/xml, text/xml

Sample:
<ParaPerson xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models">
  <AnyMeetingBtnCutomizedName>sample string 11</AnyMeetingBtnCutomizedName>
  <AutoClick>true</AutoClick>
  <CompanyCode>sample string 12</CompanyCode>
  <CountryCode>sample string 9</CountryCode>
  <CultureInfo>
    <CurrencyDisplay>sample string 4</CurrencyDisplay>
    <DateDisplay>sample string 1</DateDisplay>
    <DateTimeDisplay>sample string 3</DateTimeDisplay>
    <TimeDisplay>sample string 2</TimeDisplay>
  </CultureInfo>
  <CustomizedPauseImageMobileUrl>sample string 19</CustomizedPauseImageMobileUrl>
  <CustomizedPauseImageName>sample string 18</CustomizedPauseImageName>
  <CustomizedPauseImageNeeded>true</CustomizedPauseImageNeeded>
  <Email>sample string 2</Email>
  <EpicInfo xmlns:d2p1="http://schemas.datacontract.org/2004/07/WEYILib">
    <d2p1:EncounterLocation>sample string 2</d2p1:EncounterLocation>
    <d2p1:Language>sample string 3</d2p1:Language>
    <d2p1:OrgName>sample string 4</d2p1:OrgName>
    <d2p1:PatientName>sample string 1</d2p1:PatientName>
  </EpicInfo>
  <FacebookEmail>sample string 7</FacebookEmail>
  <GlobalServerId>1</GlobalServerId>
  <GreetingText>sample string 13</GreetingText>
  <HomePageButtonViewOptionCodeId>1</HomePageButtonViewOptionCodeId>
  <HomePageText>sample string 14</HomePageText>
  <Id>1</Id>
  <InterpreterBtnText>sample string 16</InterpreterBtnText>
  <LanguageList>
    <ParaPersonLanguage>
      <LanguageId>1</LanguageId>
      <ProficiencyCodeId>2</ProficiencyCodeId>
    </ParaPersonLanguage>
    <ParaPersonLanguage>
      <LanguageId>1</LanguageId>
      <ProficiencyCodeId>2</ProficiencyCodeId>
    </ParaPersonLanguage>
  </LanguageList>
  <MobilePhone>sample string 5</MobilePhone>
  <Name>sample string 1</Name>
  <NeedAnyMeetingBtnCustomizedName>true</NeedAnyMeetingBtnCustomizedName>
  <NeedLocationBeforeRequest>true</NeedLocationBeforeRequest>
  <Password>sample string 6</Password>
  <PatientBtnText>sample string 15</PatientBtnText>
  <PersonAnyMeetingEnabled>true</PersonAnyMeetingEnabled>
  <PersonBillingType>10</PersonBillingType>
  <PersonMTEnabled>true</PersonMTEnabled>
  <PersonPreLanguageScriptUrl>sample string 17</PersonPreLanguageScriptUrl>
  <PersonReconnectPopupHoldSecs>1</PersonReconnectPopupHoldSecs>
  <PersonServiceStatusCode>1</PersonServiceStatusCode>
  <PersonTransactionHistoryEnabled>true</PersonTransactionHistoryEnabled>
  <PersonVoiceRecognitionLanguageMapId>1</PersonVoiceRecognitionLanguageMapId>
  <RegionCode>sample string 3</RegionCode>
  <RegionId>1</RegionId>
  <RegionShortCode>sample string 4</RegionShortCode>
  <RegistrationStatusCodeId>1</RegistrationStatusCodeId>
  <Status>sample string 8</Status>
  <StatusCodeId>1</StatusCodeId>
  <SystemLanguageId>1</SystemLanguageId>
  <TrainStatusCodeId>1</TrainStatusCodeId>
  <isScheduleEnabled>true</isScheduleEnabled>
  <isVoiceRecognitionEnabled>1</isVoiceRecognitionEnabled>
  <isWebApp>true</isWebApp>
</ParaPerson>

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>