Hide Table of Contents
PDM Pro API Web Service
Postapi/{vaultName}/notifications
PDM Pro API Web Service > Notification Resource Group : api/{vaultName}/notifications (Post)
Description
POST: api/{VaultName}/notifications Send message

 

Sends the specified message.

Parameters
NameDescriptionData Type
(URI parameter) Vault name (required)string

(Body parameter) Recipient user ID

 

Member of MsgInfo model

integer

(Body parameter) Subject text

 

Member of MsgInfo model

 

string

(Body parameter) Message text

 

Member of MsgInfo model

 

string

(Body parameter) Password

 

Member of MsgInfo model

 

string
Request (application/json, text/json)

Sample Data

{
  "RecipientId": 1,
  "Subject": "sample string 2",
  "Message": "sample string 3",
  "Password": "sample string 4"
}
Request (application/xml, text/xml)

Sample Data

<MsgInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SWPDM.Models">
  <Message>sample string 3</Message>
  <Password>sample string 4</Password>
  <RecipientId>1</RecipientId>
  <Subject>sample string 2</Subject>
</MsgInfo>
Request (application/x-www-form-urlencoded)

Response (application/json, text/json)

Returns the status of the operation; true if successful, false if not

Sample Data

true
Response (application/xml, text/xml)

Returns the status of the operation; true if successful, false if not

Sample Data

<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>
Remarks

This operation:

  • takes MsgInfo body parameters.
  • returns a boolean status.

 

See Also


Provide feedback on this topic

SOLIDWORKS welcomes your feedback concerning the presentation, accuracy, and thoroughness of the documentation. Use the form below to send your comments and suggestions about this topic directly to our documentation team. The documentation team cannot answer technical support questions. Click here for information about technical support.

* Required

 
*Email:  
Subject:   Feedback on Help Topics
Page:   api/{vaultName}/notifications (Post)
*Comment:  
*   I acknowledge I have read and I hereby accept the privacy policy under which my Personal Data will be used by Dassault Systèmes

Print Topic

Select the scope of content to print:

x

We have detected you are using a browser version older than Internet Explorer 7. For optimized display, we suggest upgrading your browser to Internet Explorer 7 or newer.

 Never show this message again
x

Web Help Content Version: API Help (English only) 2024 SP03

To disable Web help from within SOLIDWORKS and use local help instead, click Help > Use SOLIDWORKS Web Help.

To report problems encountered with the Web help interface and search, contact your local support representative. To provide feedback on individual help topics, use the “Feedback on this topic” link on the individual topic page.