POST api/Notifications/Filter?pageNumber={pageNumber}&itemsPerPage={itemsPerPage}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
pageNumber | integer |
Default value is 1 |
|
itemsPerPage | integer |
Default value is 10 |
Body Parameters
NotificationFilterName | Description | Type | Additional information |
---|---|---|---|
NotificationType | integer |
None. |
|
BookerName | string |
None. |
|
CreatedAtStartRange | date |
None. |
|
CreatedAtEndRange | date |
None. |
|
ResourceName | string |
None. |
|
ActionedBy | string |
None. |
|
BookingDateStartRange | date |
None. |
|
BookingDateEndRange | date |
None. |
|
BookingReference | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "NotificationType": 1, "BookerName": "sample string 1", "CreatedAtStartRange": "2025-03-31T05:00:54.3075513+00:00", "CreatedAtEndRange": "2025-03-31T05:00:54.3075513+00:00", "ResourceName": "sample string 4", "ActionedBy": "sample string 5", "BookingDateStartRange": "2025-03-31T05:00:54.3075513+00:00", "BookingDateEndRange": "2025-03-31T05:00:54.3075513+00:00", "BookingReference": "sample string 8" }
application/xml, text/xml
Sample:
<NotificationFilter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.API.Model"> <ActionedBy>sample string 5</ActionedBy> <BookerName>sample string 1</BookerName> <BookingDateEndRange xmlns:d2p1="http://schemas.datacontract.org/2004/07/System"> <d2p1:DateTime>2025-03-31T05:00:54.3075513Z</d2p1:DateTime> <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes> </BookingDateEndRange> <BookingDateStartRange xmlns:d2p1="http://schemas.datacontract.org/2004/07/System"> <d2p1:DateTime>2025-03-31T05:00:54.3075513Z</d2p1:DateTime> <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes> </BookingDateStartRange> <BookingReference>sample string 8</BookingReference> <CreatedAtEndRange xmlns:d2p1="http://schemas.datacontract.org/2004/07/System"> <d2p1:DateTime>2025-03-31T05:00:54.3075513Z</d2p1:DateTime> <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes> </CreatedAtEndRange> <CreatedAtStartRange xmlns:d2p1="http://schemas.datacontract.org/2004/07/System"> <d2p1:DateTime>2025-03-31T05:00:54.3075513Z</d2p1:DateTime> <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes> </CreatedAtStartRange> <NotificationType>1</NotificationType> <ResourceName>sample string 4</ResourceName> </NotificationFilter>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
PaginatedResultsOfNotificationName | Description | Type | Additional information |
---|---|---|---|
TotalPages | integer |
None. |
|
CurrentPage | integer |
None. |
|
Results | Collection of Notification |
None. |
|
Count | integer |
None. |
Response Formats
application/json, text/json
Sample:
{ "TotalPages": 1, "CurrentPage": 2, "Results": [ { "Description": "sample string 1", "ApproveLink": "http://webapihelppage2.com", "RejectLink": "http://webapihelppage3.com", "RequestMoreInfoLink": "http://webapihelppage4.com", "CreatedAt": "2025-03-31T05:00:54.3075513+00:00", "ActionRequired": true, "BookerEmailAddress": "sample string 7", "BookerName": "sample string 8", "EventName": "sample string 9", "Notes": { "Note": "sample string 1", "Author": "sample string 2" }, "NotificationType": "sample string 10", "EventIdentity": "1d3b850e-a217-45ee-9c89-5bb67dca75a7", "Schedule": [ { "StartDateTime": "2025-03-31T05:00:54.3075513+00:00", "Duration": 2.1 }, { "StartDateTime": "2025-03-31T05:00:54.3075513+00:00", "Duration": 2.1 } ], "ResourceName": "sample string 12", "ResourceTypeName": "sample string 13", "ActionedAt": "2025-03-31T05:00:54.3075513+00:00", "ActionedBy": "sample string 15", "Reference": "sample string 16" }, { "Description": "sample string 1", "ApproveLink": "http://webapihelppage2.com", "RejectLink": "http://webapihelppage3.com", "RequestMoreInfoLink": "http://webapihelppage4.com", "CreatedAt": "2025-03-31T05:00:54.3075513+00:00", "ActionRequired": true, "BookerEmailAddress": "sample string 7", "BookerName": "sample string 8", "EventName": "sample string 9", "Notes": { "Note": "sample string 1", "Author": "sample string 2" }, "NotificationType": "sample string 10", "EventIdentity": "1d3b850e-a217-45ee-9c89-5bb67dca75a7", "Schedule": [ { "StartDateTime": "2025-03-31T05:00:54.3075513+00:00", "Duration": 2.1 }, { "StartDateTime": "2025-03-31T05:00:54.3075513+00:00", "Duration": 2.1 } ], "ResourceName": "sample string 12", "ResourceTypeName": "sample string 13", "ActionedAt": "2025-03-31T05:00:54.3075513+00:00", "ActionedBy": "sample string 15", "Reference": "sample string 16" } ], "Count": 3 }
application/xml, text/xml
Sample:
<PaginatedResultsOfNotificationqMSKJDOU xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scientia.Platform.API.Model"> <Count>3</Count> <CurrentPage>2</CurrentPage> <Results> <Notification> <ActionRequired>true</ActionRequired> <ActionedAt xmlns:d4p1="http://schemas.datacontract.org/2004/07/System"> <d4p1:DateTime>2025-03-31T05:00:54.3075513Z</d4p1:DateTime> <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes> </ActionedAt> <ActionedBy>sample string 15</ActionedBy> <ApproveLink>http://webapihelppage2.com/</ApproveLink> <BookerEmailAddress>sample string 7</BookerEmailAddress> <BookerName>sample string 8</BookerName> <CreatedAt xmlns:d4p1="http://schemas.datacontract.org/2004/07/System"> <d4p1:DateTime>2025-03-31T05:00:54.3075513Z</d4p1:DateTime> <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes> </CreatedAt> <Description>sample string 1</Description> <EventIdentity>1d3b850e-a217-45ee-9c89-5bb67dca75a7</EventIdentity> <EventName>sample string 9</EventName> <Notes> <Author>sample string 2</Author> <Note>sample string 1</Note> </Notes> <NotificationType>sample string 10</NotificationType> <Reference>sample string 16</Reference> <RejectLink>http://webapihelppage3.com/</RejectLink> <RequestMoreInfoLink>http://webapihelppage4.com/</RequestMoreInfoLink> <ResourceName>sample string 12</ResourceName> <ResourceTypeName>sample string 13</ResourceTypeName> <Schedule> <Schedule> <Duration>2.1</Duration> <StartDateTime xmlns:d6p1="http://schemas.datacontract.org/2004/07/System"> <d6p1:DateTime>2025-03-31T05:00:54.3075513Z</d6p1:DateTime> <d6p1:OffsetMinutes>0</d6p1:OffsetMinutes> </StartDateTime> </Schedule> <Schedule> <Duration>2.1</Duration> <StartDateTime xmlns:d6p1="http://schemas.datacontract.org/2004/07/System"> <d6p1:DateTime>2025-03-31T05:00:54.3075513Z</d6p1:DateTime> <d6p1:OffsetMinutes>0</d6p1:OffsetMinutes> </StartDateTime> </Schedule> </Schedule> </Notification> <Notification> <ActionRequired>true</ActionRequired> <ActionedAt xmlns:d4p1="http://schemas.datacontract.org/2004/07/System"> <d4p1:DateTime>2025-03-31T05:00:54.3075513Z</d4p1:DateTime> <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes> </ActionedAt> <ActionedBy>sample string 15</ActionedBy> <ApproveLink>http://webapihelppage2.com/</ApproveLink> <BookerEmailAddress>sample string 7</BookerEmailAddress> <BookerName>sample string 8</BookerName> <CreatedAt xmlns:d4p1="http://schemas.datacontract.org/2004/07/System"> <d4p1:DateTime>2025-03-31T05:00:54.3075513Z</d4p1:DateTime> <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes> </CreatedAt> <Description>sample string 1</Description> <EventIdentity>1d3b850e-a217-45ee-9c89-5bb67dca75a7</EventIdentity> <EventName>sample string 9</EventName> <Notes> <Author>sample string 2</Author> <Note>sample string 1</Note> </Notes> <NotificationType>sample string 10</NotificationType> <Reference>sample string 16</Reference> <RejectLink>http://webapihelppage3.com/</RejectLink> <RequestMoreInfoLink>http://webapihelppage4.com/</RequestMoreInfoLink> <ResourceName>sample string 12</ResourceName> <ResourceTypeName>sample string 13</ResourceTypeName> <Schedule> <Schedule> <Duration>2.1</Duration> <StartDateTime xmlns:d6p1="http://schemas.datacontract.org/2004/07/System"> <d6p1:DateTime>2025-03-31T05:00:54.3075513Z</d6p1:DateTime> <d6p1:OffsetMinutes>0</d6p1:OffsetMinutes> </StartDateTime> </Schedule> <Schedule> <Duration>2.1</Duration> <StartDateTime xmlns:d6p1="http://schemas.datacontract.org/2004/07/System"> <d6p1:DateTime>2025-03-31T05:00:54.3075513Z</d6p1:DateTime> <d6p1:OffsetMinutes>0</d6p1:OffsetMinutes> </StartDateTime> </Schedule> </Schedule> </Notification> </Results> <TotalPages>1</TotalPages> </PaginatedResultsOfNotificationqMSKJDOU>