POST api/modules/dossierportal/dossierportals

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Active	boolean	None.
AutoCreateUsers	boolean	None.
EntityAttributeId	integer	None.
EntityDefinitionId	integer	None.
Version	byte	None.
Permissions	Collection of DossierPortalPermissionViewModel	None.

Request Formats

application/json, text/json

Sample:

{
  "Active": true,
  "AutoCreateUsers": true,
  "EntityAttributeId": 1,
  "EntityDefinitionId": 1,
  "Version": 64,
  "Permissions": [
    {
      "EntityAttributeId": 1,
      "EntityCategoryId": 1,
      "EntityDefinitionId": 1,
      "FileDirectoryId": 1,
      "Id": 1,
      "PermissionId": 2
    },
    {
      "EntityAttributeId": 1,
      "EntityCategoryId": 1,
      "EntityDefinitionId": 1,
      "FileDirectoryId": 1,
      "Id": 1,
      "PermissionId": 2
    }
  ]
}

application/xml, text/xml

Sample:

<CreateDossierPortalViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VobeSoft.Shared.Models.ViewModels">
  <Active>true</Active>
  <AutoCreateUsers>true</AutoCreateUsers>
  <EntityAttributeId>1</EntityAttributeId>
  <EntityDefinitionId>1</EntityDefinitionId>
  <Permissions>
    <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>
  </Permissions>
  <Version>64</Version>
</CreateDossierPortalViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ReadDossierPortalEntryViewModel

Name	Type	Additional information
Active	boolean	None.
AutoCreateUsers	boolean	None.
DefaultPermissions	Collection of DossierPortalPermissionViewModel	None.
EmailEntityAttributeId	integer	None.
EntityDefinitionId	integer	None.
Id	integer	None.
Version	byte	None.
UserPropagations	integer	None.
PrimaryColor	string	None.
SecondaryColor	string	None.
TertiaryColor	string	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,
  "Version": 64,
  "UserPropagations": 5,
  "PrimaryColor": "sample string 6",
  "SecondaryColor": "sample string 7",
  "TertiaryColor": "sample string 8"
}

application/xml, text/xml

Sample:

<ReadDossierPortalEntryViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VobeSoft.Shared.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>
  <PrimaryColor>sample string 6</PrimaryColor>
  <SecondaryColor>sample string 7</SecondaryColor>
  <TertiaryColor>sample string 8</TertiaryColor>
  <UserPropagations>5</UserPropagations>
  <Version>64</Version>
</ReadDossierPortalEntryViewModel>