POST DMS/ShareWithDocument

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
DMSDocumentShare	DMSDocumentShareDTO	None.
Users	Collection of DropdownNMRNonNMRUsersDto	None.
UserGroups	Collection of DropdownDto	None.
Verticals	Collection of DropdownDto	None.
Regions	Collection of DropdownFilterArrayDto	None.
Projects	Collection of DropdownFilterArrayDto	None.
Functions	Collection of DropdownDto	None.
Positions	Collection of DropdownDto	None.
FileSharingAllowed	string	None.
UserId	integer	None.
FilesToShareList	Collection of FilesToBeShared	None.
LevelValueList	Collection of DropdownDto	None.
SharingToValueList	Collection of DropdownDto	None.
sessionDto	SessionWebAPIDto	None.

Request Formats

application/json, text/json

Sample:

{
  "DMSDocumentShare": {
    "ShareToId": 1,
    "UserId": [
      1,
      1
    ],
    "UserGroupId": [
      1,
      1
    ],
    "levelId": 2,
    "verticalIds": [
      1,
      1
    ],
    "RegionIds": [
      1,
      1
    ],
    "ProjectIds": [
      1,
      1
    ],
    "FunctionIds": [
      1,
      1
    ],
    "PositionIds": [
      1,
      1
    ],
    "LinkExpiryPeriod": 1,
    "ExternalPartyEmailId": "sample string 3",
    "AccessType": true,
    "DocumentIds": [
      1,
      2
    ],
    "EmailSalutation": "sample string 5",
    "documentCreatorName": "sample string 6",
    "documentId": "sample string 7",
    "DocumentDetails": [
      {
        "DocumentId": 1,
        "DocumentNumber": "sample string 2",
        "DocumentTitle": "sample string 3",
        "DocumentFile": "sample string 4",
        "DocumentUrl": "sample string 5",
        "DocumentAccess": "sample string 6",
        "SetDocumentPrivority": 7,
        "shareBy": 8,
        "AuthorId": 9,
        "AuthorName": "sample string 10",
        "AuthorEmail": "sample string 11"
      },
      {
        "DocumentId": 1,
        "DocumentNumber": "sample string 2",
        "DocumentTitle": "sample string 3",
        "DocumentFile": "sample string 4",
        "DocumentUrl": "sample string 5",
        "DocumentAccess": "sample string 6",
        "SetDocumentPrivority": 7,
        "shareBy": 8,
        "AuthorId": 9,
        "AuthorName": "sample string 10",
        "AuthorEmail": "sample string 11"
      }
    ]
  },
  "Users": [
    {
      "Key": 1,
      "Value": "sample string 2",
      "Category": "sample string 3",
      "SortSequence": 4,
      "SortOrderByFirstName": "sample string 5",
      "Status": "sample string 6"
    },
    {
      "Key": 1,
      "Value": "sample string 2",
      "Category": "sample string 3",
      "SortSequence": 4,
      "SortOrderByFirstName": "sample string 5",
      "Status": "sample string 6"
    }
  ],
  "UserGroups": [
    {
      "Key": 1,
      "Value": "sample string 2",
      "FilterId": 1,
      "SortSequence": 3,
      "ValueConstant": "sample string 4"
    },
    {
      "Key": 1,
      "Value": "sample string 2",
      "FilterId": 1,
      "SortSequence": 3,
      "ValueConstant": "sample string 4"
    }
  ],
  "Verticals": [
    {
      "Key": 1,
      "Value": "sample string 2",
      "FilterId": 1,
      "SortSequence": 3,
      "ValueConstant": "sample string 4"
    },
    {
      "Key": 1,
      "Value": "sample string 2",
      "FilterId": 1,
      "SortSequence": 3,
      "ValueConstant": "sample string 4"
    }
  ],
  "Regions": [
    {
      "Key": 1,
      "Value": "sample string 2",
      "FilterArray": [
        1,
        2
      ]
    },
    {
      "Key": 1,
      "Value": "sample string 2",
      "FilterArray": [
        1,
        2
      ]
    }
  ],
  "Projects": [
    {
      "Key": 1,
      "Value": "sample string 2",
      "FilterArray": [
        1,
        2
      ]
    },
    {
      "Key": 1,
      "Value": "sample string 2",
      "FilterArray": [
        1,
        2
      ]
    }
  ],
  "Functions": [
    {
      "Key": 1,
      "Value": "sample string 2",
      "FilterId": 1,
      "SortSequence": 3,
      "ValueConstant": "sample string 4"
    },
    {
      "Key": 1,
      "Value": "sample string 2",
      "FilterId": 1,
      "SortSequence": 3,
      "ValueConstant": "sample string 4"
    }
  ],
  "Positions": [
    {
      "Key": 1,
      "Value": "sample string 2",
      "FilterId": 1,
      "SortSequence": 3,
      "ValueConstant": "sample string 4"
    },
    {
      "Key": 1,
      "Value": "sample string 2",
      "FilterId": 1,
      "SortSequence": 3,
      "ValueConstant": "sample string 4"
    }
  ],
  "FileSharingAllowed": "sample string 1",
  "UserId": 2,
  "FilesToShareList": [
    {
      "DocumentId": 1,
      "FileName": "sample string 2",
      "DocumentNumber": "sample string 3",
      "FileSize": "sample string 4",
      "CurrentVersion": 5.0
    },
    {
      "DocumentId": 1,
      "FileName": "sample string 2",
      "DocumentNumber": "sample string 3",
      "FileSize": "sample string 4",
      "CurrentVersion": 5.0
    }
  ],
  "LevelValueList": [
    {
      "Key": 1,
      "Value": "sample string 2",
      "FilterId": 1,
      "SortSequence": 3,
      "ValueConstant": "sample string 4"
    },
    {
      "Key": 1,
      "Value": "sample string 2",
      "FilterId": 1,
      "SortSequence": 3,
      "ValueConstant": "sample string 4"
    }
  ],
  "SharingToValueList": [
    {
      "Key": 1,
      "Value": "sample string 2",
      "FilterId": 1,
      "SortSequence": 3,
      "ValueConstant": "sample string 4"
    },
    {
      "Key": 1,
      "Value": "sample string 2",
      "FilterId": 1,
      "SortSequence": 3,
      "ValueConstant": "sample string 4"
    }
  ],
  "sessionDto": {
    "DepartmentName": "sample string 1",
    "DepartmentId": 2,
    "RoleId": 3,
    "CurrentRoleName": "sample string 4",
    "FirstName": "sample string 5",
    "LastName": "sample string 6",
    "UserId": 7,
    "ObservationId": 8,
    "IsElevated": true,
    "IncidentId": 10,
    "InjuredWorkerId": 11,
    "InjuryCauseId": 12,
    "CorrectiveActions": "sample string 13",
    "HandSkillTrainingId": 14,
    "CheckListId": 15,
    "CheckListResponseId": 16,
    "CustomerComplaintId": 17,
    "WorkPermitId": 18,
    "WorkPermitTypeId": 19,
    "ProjectId": 20,
    "WorkPermitStatus": "sample string 21",
    "InspectionId": 22,
    "ObservationIdlist": [
      1,
      2
    ],
    "ClosedRemark": "sample string 23",
    "WorkPermitDefinationId": 24,
    "IsOfflineData": true,
    "DataCreationDate": "sample string 26",
    "IsFromMobile": true,
    "CancelledByHSEOfficerId": 28,
    "DocumentId": 29,
    "Title": "sample string 30",
    "_userAccessPermissions": [
      {
        "LevelId": 1,
        "LevelName": "sample string 2",
        "DepartmentId": 3,
        "DepartmentName": "sample string 4",
        "DepartmentType": "sample string 5",
        "PositionId": 6,
        "PositionName": "sample string 7",
        "PositionImportance": 8
      },
      {
        "LevelId": 1,
        "LevelName": "sample string 2",
        "DepartmentId": 3,
        "DepartmentName": "sample string 4",
        "DepartmentType": "sample string 5",
        "PositionId": 6,
        "PositionName": "sample string 7",
        "PositionImportance": 8
      }
    ],
    "UserAccessPermissions": [
      {
        "LevelId": 1,
        "LevelName": "sample string 2",
        "DepartmentId": 3,
        "DepartmentName": "sample string 4",
        "DepartmentType": "sample string 5",
        "PositionId": 6,
        "PositionName": "sample string 7",
        "PositionImportance": 8
      },
      {
        "LevelId": 1,
        "LevelName": "sample string 2",
        "DepartmentId": 3,
        "DepartmentName": "sample string 4",
        "DepartmentType": "sample string 5",
        "PositionId": 6,
        "PositionName": "sample string 7",
        "PositionImportance": 8
      }
    ]
  }
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.