GET api/requiredfields/{moduleid}

Retreive a list of permissions for required Patient fields for a specific App defined by it's moduleid. Must have a valid Authorization header. Required fields must be filled when creating a new patient. NOTE : API Version 1.1

Request Information

URI Parameters

NameDescriptionTypeAdditional information
moduleid

App moduleid

integer

Required

Body Parameters

None.

Response Information

Resource Description

A list of AppPermissions for required Patient fields for the module

Collection of AppPermission
NameDescriptionTypeAdditional information
PermissionID

The ID that identifies the permission

integer

None.

Name

The name of the Patient field that this permission relates to

string

None.

Type

The C# type of the property. (0 = DateTime, 1 = Int16, 2 = Int32, 3 = String - Internal Noah Types)

integer

None.

Required

Specify whether or not this field is required when creating/changing a patient record

boolean

None.

Default

Is the permission a default permission i.e. part of the permission that a new app gets when it registers with Noah

boolean

None.

MinLength

Minimum length of the field (only valid for strings)

integer

None.

MaxLength

Maximum length of the field (only valid for strings)

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "PermissionID": 1,
    "Name": "sample string 2",
    "Type": 3,
    "Required": true,
    "Default": true,
    "MinLength": 6,
    "MaxLength": 7
  },
  {
    "PermissionID": 1,
    "Name": "sample string 2",
    "Type": 3,
    "Required": true,
    "Default": true,
    "MinLength": 6,
    "MaxLength": 7
  }
]

application/xml, text/xml

Sample:
<ArrayOfAppPermission xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Himsa.Noah.Public.Model">
  <AppPermission>
    <Default>true</Default>
    <MaxLength>7</MaxLength>
    <MinLength>6</MinLength>
    <Name>sample string 2</Name>
    <PermissionID>1</PermissionID>
    <Required>true</Required>
    <Type>3</Type>
  </AppPermission>
  <AppPermission>
    <Default>true</Default>
    <MaxLength>7</MaxLength>
    <MinLength>6</MinLength>
    <Name>sample string 2</Name>
    <PermissionID>1</PermissionID>
    <Required>true</Required>
    <Type>3</Type>
  </AppPermission>
</ArrayOfAppPermission>