GET api/Notifications?timeZone={timeZone}&pageNumber={pageNumber}&itemsPerPage={itemsPerPage}&requiresAction={requiresAction}&notificationType={notificationType}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
timeZone

integer

Default value is 0

pageNumber

integer

Default value is 1

itemsPerPage

integer

Default value is 10

requiresAction

boolean

None.

notificationType

integer

Default value is -1

Body Parameters

None.

Response Information

Resource Description

PaginatedResultsOfNotification
NameDescriptionTypeAdditional 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:07:41.2602096+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": "db9ecaa8-048c-4b5b-9a18-259360c05599",
      "Schedule": [
        {
          "StartDateTime": "2025-03-31T05:07:41.2602096+00:00",
          "Duration": 2.1
        },
        {
          "StartDateTime": "2025-03-31T05:07:41.2602096+00:00",
          "Duration": 2.1
        }
      ],
      "ResourceName": "sample string 12",
      "ResourceTypeName": "sample string 13",
      "ActionedAt": "2025-03-31T05:07:41.2602096+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:07:41.2602096+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": "db9ecaa8-048c-4b5b-9a18-259360c05599",
      "Schedule": [
        {
          "StartDateTime": "2025-03-31T05:07:41.2602096+00:00",
          "Duration": 2.1
        },
        {
          "StartDateTime": "2025-03-31T05:07:41.2602096+00:00",
          "Duration": 2.1
        }
      ],
      "ResourceName": "sample string 12",
      "ResourceTypeName": "sample string 13",
      "ActionedAt": "2025-03-31T05:07:41.2602096+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:07:41.2602096Z</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:07:41.2602096Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </CreatedAt>
      <Description>sample string 1</Description>
      <EventIdentity>db9ecaa8-048c-4b5b-9a18-259360c05599</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:07:41.2602096Z</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:07:41.2602096Z</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:07:41.2602096Z</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:07:41.2602096Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </CreatedAt>
      <Description>sample string 1</Description>
      <EventIdentity>db9ecaa8-048c-4b5b-9a18-259360c05599</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:07:41.2602096Z</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:07:41.2602096Z</d6p1:DateTime>
            <d6p1:OffsetMinutes>0</d6p1:OffsetMinutes>
          </StartDateTime>
        </Schedule>
      </Schedule>
    </Notification>
  </Results>
  <TotalPages>1</TotalPages>
</PaginatedResultsOfNotificationqMSKJDOU>