GET User/MyProfile/WatchedNotice/GetAll
Gets details of all the watched notices for the signed in user, contained in a collection of WatchedNotice objects.
Requires Authorization
The endpoint requires a bearer token in the http authorization header. For example "bearer 2YotnFZFEjr1zCsicMWpAA"
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
A collection of WatchedNotice objects associated with the signed in user.
Collection of WatchedNotice| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
Gets or sets id of watch |
integer |
None. |
| Name |
Gets or sets name of watch |
string |
None. |
| CountdownAlert |
Gets or sets number of days prior to deadline |
CountdownAlert |
None. |
| IncludeUpdates |
Gets or sets a value indicating whether to send contract-changed alerts |
boolean |
None. |
| NoticeId |
Gets or sets id of notice to be watched |
globally unique identifier |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"id": 1,
"name": "Notice reminder",
"countdownAlert": "DeadlineDay",
"includeUpdates": true,
"noticeId": "08db128a-ecff-4aca-95b9-66875e531bdf"
},
{
"id": 2,
"name": "Possible work notice",
"countdownAlert": "BeforeThree",
"includeUpdates": false,
"noticeId": "7df0f39f-db75-40d7-bd29-8f90e2946493"
}
]
application/xml, text/xml
Sample:
<ArrayOfWatchedNotice xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IPL.ContractsFinder.BusinessEntities">
<WatchedNotice>
<CountdownAlert>DeadlineDay</CountdownAlert>
<Id>1</Id>
<IncludeUpdates>true</IncludeUpdates>
<Name>Notice reminder</Name>
<NoticeId>08db128a-ecff-4aca-95b9-66875e531bdf</NoticeId>
</WatchedNotice>
<WatchedNotice>
<CountdownAlert>BeforeThree</CountdownAlert>
<Id>2</Id>
<IncludeUpdates>false</IncludeUpdates>
<Name>Possible work notice</Name>
<NoticeId>7df0f39f-db75-40d7-bd29-8f90e2946493</NoticeId>
</WatchedNotice>
</ArrayOfWatchedNotice>