POST api/Activator

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
LicenceKey	globally unique identifier	None.
Email	string	None.
DeviceInfo	DeviceInfo	None.

Request Formats

application/json, text/json

Sample:

{
  "licenceKey": "766672a8-f38d-45ac-9150-ba1a75ab3560",
  "email": "sample string 2",
  "deviceInfo": {
    "id": "sample string 1",
    "languageCode": "sample string 2",
    "manufacturer": "sample string 3",
    "hardwareVersion": "sample string 4",
    "os": "sample string 5",
    "firmwareVersion": "sample string 6",
    "name": "sample string 7",
    "timeZone": "sample string 8"
  }
}

application/xml, text/xml

Sample:

<ActivationModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eMedit.eDoktor.WebApi.Models.Api.MobileClientActivation">
  <DeviceInfo>
    <FirmwareVersion>sample string 6</FirmwareVersion>
    <HardwareVersion>sample string 4</HardwareVersion>
    <Id>sample string 1</Id>
    <LanguageCode>sample string 2</LanguageCode>
    <Manufacturer>sample string 3</Manufacturer>
    <Name>sample string 7</Name>
    <OS>sample string 5</OS>
    <TimeZone>sample string 8</TimeZone>
  </DeviceInfo>
  <Email>sample string 2</Email>
  <LicenceKey>766672a8-f38d-45ac-9150-ba1a75ab3560</LicenceKey>
</ActivationModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ActivationResult

Name	Type	Additional information
PIN	string	None.
UserID	integer	None.
Credentials	UserCredentials	None.

Response Formats

application/json, text/json

Sample:

{
  "pin": "sample string 1",
  "userID": 2,
  "credentials": {
    "fullName": "sample string 1",
    "openPACSOnOpenCase": true,
    "urlAfterSubmitReferralResponse": "sample string 3",
    "urlAfterTherapyConfirm": "sample string 4",
    "telephoneNumber": "sample string 5",
    "viewHeader": true,
    "viewFooter": true,
    "viewNavigation": true,
    "rootLocationId": 9,
    "notifyAccessToken": "sample string 10",
    "userId": 11,
    "healthProfessionalId": 1,
    "username": "sample string 12",
    "displayName": "sample string 13",
    "currentCabinetId": 14,
    "currentCabinetName": "sample string 15",
    "cabinetIsAutopsy": true,
    "currentInstitutionName": "sample string 17",
    "currentInstitutionId": 18,
    "userCabinets": [
      1,
      2
    ],
    "userCabinetIds": [
      1,
      2
    ],
    "userCabinetsCode": [
      "sample string 1",
      "sample string 2"
    ],
    "mdulsUserCode": "sample string 19",
    "worklistCabinets": [
      1,
      2
    ],
    "worklistSourceCabinets": [
      1,
      2
    ],
    "worklistOnlyIntended": true,
    "worklistFilterByCurrentCabinet": true,
    "worklistShowStatuses": [
      1,
      2
    ],
    "myWorklistShowStatuses": [
      1,
      2
    ],
    "userRoles": [
      1,
      2
    ],
    "userPermissions": [
      1,
      2
    ],
    "userPin": "sample string 22",
    "userPersonalCode": "sample string 23",
    "userTypeId": 24,
    "currentWardId": 1,
    "currentWardName": "sample string 25",
    "currentLocationId": 26,
    "defaultAreaPath": "sample string 27",
    "currentSubHospitalId": 28,
    "currentMedicalActivityId": 29,
    "defaultAreaLayout": "sample string 30",
    "aisAccessToken": "sample string 31",
    "oAuthAccessToken": "sample string 32",
    "defaultLanguageCode": "sample string 33",
    "defaultLanguageId": 34,
    "defaultSpeechMikeType": "sample string 35",
    "defaultInputFontSize": 36,
    "printReferralResponseOnVerify": true,
    "autorefreshWorklist": true,
    "worklistColumnSettings": "sample string 39",
    "administrationController": "sample string 40",
    "administrationArea": "sample string 41",
    "autoStartExternalApplication": true,
    "medicalRecordPartialView": "sample string 43",
    "currentCabinetLocalId": "sample string 44"
  }
}

application/xml, text/xml

Sample:

<ActivationResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eMedit.eDoktor.WebApi.Models.Api.MobileClientActivation">
  <Credentials xmlns:d2p1="http://schemas.datacontract.org/2004/07/eMedit.eDoktor.BDO.Common">
    <d2p1:AdministrationArea>sample string 41</d2p1:AdministrationArea>
    <d2p1:AdministrationController>sample string 40</d2p1:AdministrationController>
    <d2p1:AisAccessToken>sample string 31</d2p1:AisAccessToken>
    <d2p1:AutoStartExternalApplication>true</d2p1:AutoStartExternalApplication>
    <d2p1:AutorefreshWorklist>true</d2p1:AutorefreshWorklist>
    <d2p1:CabinetIsAutopsy>true</d2p1:CabinetIsAutopsy>
    <d2p1:CurrentCabinetId>14</d2p1:CurrentCabinetId>
    <d2p1:CurrentCabinetLocalId>sample string 44</d2p1:CurrentCabinetLocalId>
    <d2p1:CurrentCabinetName>sample string 15</d2p1:CurrentCabinetName>
    <d2p1:CurrentInstitutionId>18</d2p1:CurrentInstitutionId>
    <d2p1:CurrentInstitutionName>sample string 17</d2p1:CurrentInstitutionName>
    <d2p1:CurrentLocationId>26</d2p1:CurrentLocationId>
    <d2p1:CurrentMedicalActivityId>29</d2p1:CurrentMedicalActivityId>
    <d2p1:CurrentSubHospitalId>28</d2p1:CurrentSubHospitalId>
    <d2p1:CurrentWardId>1</d2p1:CurrentWardId>
    <d2p1:CurrentWardName>sample string 25</d2p1:CurrentWardName>
    <d2p1:DefaultAreaLayout>sample string 30</d2p1:DefaultAreaLayout>
    <d2p1:DefaultAreaPath>sample string 27</d2p1:DefaultAreaPath>
    <d2p1:DefaultInputFontSize>36</d2p1:DefaultInputFontSize>
    <d2p1:DefaultLanguageCode>sample string 33</d2p1:DefaultLanguageCode>
    <d2p1:DefaultLanguageId>34</d2p1:DefaultLanguageId>
    <d2p1:DefaultSpeechMikeType>sample string 35</d2p1:DefaultSpeechMikeType>
    <d2p1:DisplayName>sample string 13</d2p1:DisplayName>
    <d2p1:FullName>sample string 1</d2p1:FullName>
    <d2p1:HealthProfessionalId>1</d2p1:HealthProfessionalId>
    <d2p1:MdulsUserCode>sample string 19</d2p1:MdulsUserCode>
    <d2p1:MedicalRecordPartialView>sample string 43</d2p1:MedicalRecordPartialView>
    <d2p1:MyWorklistShowStatuses xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </d2p1:MyWorklistShowStatuses>
    <d2p1:NotifyAccessToken>sample string 10</d2p1:NotifyAccessToken>
    <d2p1:OAuthAccessToken>sample string 32</d2p1:OAuthAccessToken>
    <d2p1:OpenPACSOnOpenCase>true</d2p1:OpenPACSOnOpenCase>
    <d2p1:PrintReferralResponseOnVerify>true</d2p1:PrintReferralResponseOnVerify>
    <d2p1:RootLocationId>9</d2p1:RootLocationId>
    <d2p1:TelephoneNumber>sample string 5</d2p1:TelephoneNumber>
    <d2p1:UrlAfterSubmitReferralResponse>sample string 3</d2p1:UrlAfterSubmitReferralResponse>
    <d2p1:UrlAfterTherapyConfirm>sample string 4</d2p1:UrlAfterTherapyConfirm>
    <d2p1:UserCabinetIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </d2p1:UserCabinetIds>
    <d2p1:UserCabinets xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </d2p1:UserCabinets>
    <d2p1:UserCabinetsCode xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </d2p1:UserCabinetsCode>
    <d2p1:UserId>11</d2p1:UserId>
    <d2p1:UserPermissions xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </d2p1:UserPermissions>
    <d2p1:UserPersonalCode>sample string 23</d2p1:UserPersonalCode>
    <d2p1:UserPin>sample string 22</d2p1:UserPin>
    <d2p1:UserRoles xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </d2p1:UserRoles>
    <d2p1:UserTypeId>24</d2p1:UserTypeId>
    <d2p1:Username>sample string 12</d2p1:Username>
    <d2p1:ViewFooter>true</d2p1:ViewFooter>
    <d2p1:ViewHeader>true</d2p1:ViewHeader>
    <d2p1:ViewNavigation>true</d2p1:ViewNavigation>
    <d2p1:WorklistCabinets xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </d2p1:WorklistCabinets>
    <d2p1:WorklistColumnSettings>sample string 39</d2p1:WorklistColumnSettings>
    <d2p1:WorklistFilterByCurrentCabinet>true</d2p1:WorklistFilterByCurrentCabinet>
    <d2p1:WorklistOnlyIntended>true</d2p1:WorklistOnlyIntended>
    <d2p1:WorklistShowStatuses xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </d2p1:WorklistShowStatuses>
    <d2p1:WorklistSourceCabinets xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </d2p1:WorklistSourceCabinets>
  </Credentials>
  <PIN>sample string 1</PIN>
  <UserID>2</UserID>
</ActivationResult>