Hide Table of Contents
PDM Pro API Web Service
Getapi/{vaultName}/notifications?all={all}&pageNo={pageNo}&pageSize={pageSize}
PDM Pro API Web Service > Notification Resource Group : api/{vaultName}/notifications?all={all}&pageNo={pageNo}&pageSize={pageSize} (Get)
Description
GET: api/{VaultName}/notifications Get user notifications

 

Gets the user notifications.

Parameters
NameDescriptionData Type
vaultName(URI parameter) Vault name (required)string
all(URI parameter) Whether to retrieve all notifications (default value is true)boolean
pageNo(URI parameter) Page number (default value is 0)integer
pageSize(URI parameter) Page size (default value is 0)integer
MessageId

(Response) Message ID

 

Member of Messages model

integer
Type

(Response) MsgType object; one of:

   Msgt_All = 0

   Msgt_UserMsg = 1

   Msgt_NotificationFile = 2

   Msgt_NotificationFolder = 3

   Msgt_NotificationErp = 4

   Msgt_NotificationItem = 5

   Msgt_NotificationTask = 6

   Msgt_NotificationUpgr = 7

 

Member of Messages model

 

MsgType
Subject

(Response) Subject text

 

Member of Messages model

 

string
Message

(Response) Message text

 

Member of Messages model

 

string
Time

(Response) Date

 

Member of Messages model

 

date
Sender

(Response) A UserInfo object that consists of:

   UserName (string)

   UserId (integer)

 

Member of Messages model

 

UserInfo
New

(Response) Whether the notification is new

 

Member of Messages model

 

boolean
Response (application/json, text/json)

Sample Data

[
  {
    "MessageId": 1,
    "Type": 0,
    "Subject": "sample string 2",
    "Message": "sample string 3",
    "Time": "2024-02-26T09:21:01.2981585-05:00",
    "Sender": {
      "UserName": "sample string 1",
      "UserId": 2
    },
    "New": true
  },
  {
    "MessageId": 1,
    "Type": 0,
    "Subject": "sample string 2",
    "Message": "sample string 3",
    "Time": "2024-02-26T09:21:01.2981585-05:00",
    "Sender": {
      "UserName": "sample string 1",
      "UserId": 2
    },
    "New": true
  }
]
Response (application/xml, text/xml)

Sample Data

<ArrayOfMessages xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SWPDM.Models">
  <Messages>
    <Message>sample string 3</Message>
    <MessageId>1</MessageId>
    <New>true</New>
    <Sender>
      <UserId>2</UserId>
      <UserName>sample string 1</UserName>
    </Sender>
    <Subject>sample string 2</Subject>
    <Time>2024-02-26T09:21:01.2981585-05:00</Time>
    <Type>Msgt_All</Type>
  </Messages>
  <Messages>
    <Message>sample string 3</Message>
    <MessageId>1</MessageId>
    <New>true</New>
    <Sender>
      <UserId>2</UserId>
      <UserName>sample string 1</UserName>
    </Sender>
    <Subject>sample string 2</Subject>
    <Time>2024-02-26T09:21:01.2981585-05:00</Time>
    <Type>Msgt_All</Type>
  </Messages>
</ArrayOfMessages>
Remarks
This operation can return an array of Message objects.
See Also
Notification Resource Group | PDM Pro API Web Service



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?all={all}&pageNo={pageNo}&pageSize={pageSize} (Get)
*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.

0.20.36