POST api/Apps

Register an App. in Noah. Must have a valid Authorization header. The register information must be wrapped into an object of the type AppRegInfo, which contains Version, Name, ModuleId and MobileAppType. Version, Name and ModuleId is self-explanatory. ModuleAppType can be either FittingApp, MeasurementApp or GeneralApp (Case sensitive). This is a change from V1.1 where a number was applied. Call this method when you receive a response code 404 (Not Found) with an extended error code 60169.

Request Information

URI Parameters

None.

Body Parameters

AppRegInfo containing App registration information

AppRegInfo

Name	Description	Type	Additional information
Version	REQUIRED: Version of the app. The version might be displayed in the configuration settings of the Business System.	string	None.
Name	REQUIRED: App name. The Name might displayed in the configuration settings of the Business System.	string	None.
ModuleId	REQUIRED: ModuleId. This id can be used to display the ModuleId of the app in the configuration settings of the Business System.	integer	None.
MobileAppType	REQUIRED: mobile app type. Note it this is changed from the pevious version of the API (1.1) where it was numbers. App type must be set to identify the apps data access rights. String is case sensitive App type to use if app can do fitting. Write FittingApp App type to use if app can do measurements e.g. audiograms, REM Write MeasurementApp App type to use if your app is of a more general nature e.g. handling jounal records Write GeneralApp	string	None.
Requirements	REQUIRED: AppDataRequirements. Property was added in Api version 1.4 This class describes the data access requested by the ServiceApp. This includes read, write and messages about changes.	AppDataRequirements	None.

Request Formats

application/json, text/json

Sample:

{
  "Version": "sample string 1",
  "Name": "sample string 2",
  "ModuleId": 3,
  "MobileAppType": "sample string 4",
  "Requirements": {
    "ReadDatatypeCodes": [
      1,
      2
    ],
    "WriteDatatypeCodes": [
      1,
      2
    ],
    "MessageDatatypeCodes": [
      1,
      2
    ],
    "MessageManufacturers": [
      1,
      2
    ],
    "MessageTypes": [
      1,
      2
    ],
    "ReadPatientData": 0,
    "WritePatientData": true,
    "MessagePatientData": true,
    "ModuleId": 3
  }
}

application/xml, text/xml

Sample:

<AppRegInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Himsa.Noah.Public.Model">
  <MobileAppType>sample string 4</MobileAppType>
  <ModuleId>3</ModuleId>
  <Name>sample string 2</Name>
  <Requirements>
    <MessageDatatypeCodes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </MessageDatatypeCodes>
    <MessageManufacturers xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </MessageManufacturers>
    <MessagePatientData>true</MessagePatientData>
    <MessageTypes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </MessageTypes>
    <ModuleId>3</ModuleId>
    <ReadDatatypeCodes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </ReadDatatypeCodes>
    <ReadPatientData>Full</ReadPatientData>
    <WriteDatatypeCodes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </WriteDatatypeCodes>
    <WritePatientData>true</WritePatientData>
  </Requirements>
  <Version>sample string 1</Version>
</AppRegInfo>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

None

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.