GET api/modules/dossierportal/dossierportals/{dossierPortalId}

Gets an existing DossierPortal.



Request Information

URI Parameters

NameDescriptionTypeAdditional information
dossierPortalId

The id of the DossierPortal.

integer

Required



Body Parameters

None.



Response Information

Resource Description

The DossierPortal represented as a ReadDossierPortalEntryViewModel.

ReadDossierPortalEntryViewModel

NameDescriptionTypeAdditional information
Active

boolean

None.

AutoCreateUsers

boolean

None.

DefaultPermissions

Collection of DossierPortalPermissionViewModel

None.

EmailEntityAttributeId

integer

None.

EntityDefinitionId

integer

None.

Id

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "Active": true,
  "AutoCreateUsers": true,
  "DefaultPermissions": [
    {
      "EntityAttributeId": 1,
      "EntityCategoryId": 1,
      "EntityDefinitionId": 1,
      "FileDirectoryId": 1,
      "Id": 1,
      "PermissionId": 2
    },
    {
      "EntityAttributeId": 1,
      "EntityCategoryId": 1,
      "EntityDefinitionId": 1,
      "FileDirectoryId": 1,
      "Id": 1,
      "PermissionId": 2
    }
  ],
  "EmailEntityAttributeId": 1,
  "EntityDefinitionId": 1,
  "Id": 3
}

application/xml, text/xml

Sample:
<ReadDossierPortalEntryViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VobeSoft.Models.ViewModels">
  <Active>true</Active>
  <AutoCreateUsers>true</AutoCreateUsers>
  <DefaultPermissions>
    <DossierPortalPermissionViewModel>
      <EntityAttributeId>1</EntityAttributeId>
      <EntityCategoryId>1</EntityCategoryId>
      <EntityDefinitionId>1</EntityDefinitionId>
      <FileDirectoryId>1</FileDirectoryId>
      <Id>1</Id>
      <PermissionId>2</PermissionId>
    </DossierPortalPermissionViewModel>
    <DossierPortalPermissionViewModel>
      <EntityAttributeId>1</EntityAttributeId>
      <EntityCategoryId>1</EntityCategoryId>
      <EntityDefinitionId>1</EntityDefinitionId>
      <FileDirectoryId>1</FileDirectoryId>
      <Id>1</Id>
      <PermissionId>2</PermissionId>
    </DossierPortalPermissionViewModel>
  </DefaultPermissions>
  <EmailEntityAttributeId>1</EmailEntityAttributeId>
  <EntityDefinitionId>1</EntityDefinitionId>
  <Id>3</Id>
</ReadDossierPortalEntryViewModel>