Share
Interface Function
Share,and send email and notification.
Parameter Type
Parameter | Type | Remarks |
---|---|---|
DocumentId | String | Document Id |
ShareDocTitle | String | Title |
StaffName | String | User name |
UserId | String | UserId, guid format |
EntityName | String | Form alias, the identity of the form |
EmailTemplateCode | String | Email template code, template code is a guid string, which can be obtained from the Email template interface |
ShareToRelation | List<ShareToRelations> |
The info of associated users |
Message | String | message |
DocumentLink | String | Document link |
Share to Relations:
Parameter | Type | Remarks |
---|---|---|
UserId | String | UserId, guid format |
StaffId | String | Obsolete |
StaffName | String | User name |
String | User email |
Note
The interface returns an error if the email is sent incorrectly. The number of notifications has no impact on the return value.
Return Data Type
int: return value is the number of ShareToRelationsValue.
Input Sample
{
"DocumentId": "4ef5982872bc47ba92fc063e3685c209",
"ShareDocTitle": "GS-Hydro Coordination",
"StaffName": "DemoUser",
"UserId": "90aacf16-a039-49bf-8605-8de3ddac879c",
"EntityName": "DemoFormAlias",
"EmailTemplateCode": "92f88170-fdae-4e6e-b90b-e9e7731c8ccf",
"ShareToRelationsValue": [
{
"StaffId": "90aacf16-a039-49bf-8605-8de3ddac879c",
"StaffName": "DemoUser",
"Email": "demo@digitalmaker.com",
"UserId": "90aacf16-a039-49bf-8605-8de3ddac879c"
}
],
"Message": "",
"DocumentLink": "https://digitalmaker.com/DemoTenant/DemoApp/vForm/DemoFormAlias/preview/4ef5982872bc47ba92fc063e3685c209"
}
Return Sample
{
"StatusCode": 200,
"Info": "Request (or process) succeeded",
"Data": 1
}