GET api/v{version}/notification

Request Information

URI Parameters

NameDescriptionTypeAdditional information
version

The requested API version

 string

Required

Default value is 1

Body Parameters

None.

Response Information

Resource Description

Collection of Notification
NameDescriptionTypeAdditional information
Colour

string

None.
Date

date

None.
Email

string

None.
Id

integer

None.
Message

string

None.
MessageHeading

string

None.
NotificationType

string

None.
Phone

string

None.
WebAddress

string

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "Colour": "ff3311",
    "Date": "2025-04-03T18:56:54.1932598+01:00",
    "Email": null,
    "Id": 1,
    "Message": "Please phone to collect your prize",
    "MessageHeading": "You won a prize!",
    "NotificationType": "General",
    "Phone": "01173027000",
    "WebAddress": null
  },
  {
    "Colour": "ff3311",
    "Date": "2025-04-03T18:56:54.1932598+01:00",
    "Email": null,
    "Id": 1,
    "Message": "Please contact your bank",
    "MessageHeading": "Direct Debit Issue",
    "NotificationType": "Finance",
    "Phone": null,
    "WebAddress": "www.natwest.com"
  },
  {
    "Colour": "ff3311",
    "Date": "2025-04-03T18:56:54.1932598+01:00",
    "Email": null,
    "Id": 1,
    "Message": "please can you complete a survey from your recent maintenance request",
    "MessageHeading": "Complete a survey",
    "NotificationType": "Maintenance",
    "Phone": "01173027000",
    "WebAddress": "www.survey.com?flshdflh43lkjhrk34h5kjh4lkrjf"
  }
]

text/javascript

Sample: 
[{"Colour":"ff3311","Date":"2025-04-03T18:56:54.1932598+01:00","Email":null,"Id":1,"Message":"Please phone to collect your prize","MessageHeading":"You won a prize!","NotificationType":"General","Phone":"01173027000","WebAddress":null},{"Colour":"ff3311","Date":"2025-04-03T18:56:54.1932598+01:00","Email":null,"Id":1,"Message":"Please contact your bank","MessageHeading":"Direct Debit Issue","NotificationType":"Finance","Phone":null,"WebAddress":"www.natwest.com"},{"Colour":"ff3311","Date":"2025-04-03T18:56:54.1932598+01:00","Email":null,"Id":1,"Message":"please can you complete a survey from your recent maintenance request","MessageHeading":"Complete a survey","NotificationType":"Maintenance","Phone":"01173027000","WebAddress":"www.survey.com?flshdflh43lkjhrk34h5kjh4lkrjf"}]

application/xml, text/xml

Sample: 
<ArrayOfNotification xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UNITE.External.API.Models">
  <Notification>
    <Colour>ff3311</Colour>
    <Date>2025-04-03T18:56:54.1932598+01:00</Date>
    <Email i:nil="true" />
    <Id>1</Id>
    <Message>Please phone to collect your prize</Message>
    <MessageHeading>You won a prize!</MessageHeading>
    <NotificationType>General</NotificationType>
    <Phone>01173027000</Phone>
    <WebAddress i:nil="true" />
  </Notification>
  <Notification>
    <Colour>ff3311</Colour>
    <Date>2025-04-03T18:56:54.1932598+01:00</Date>
    <Email i:nil="true" />
    <Id>1</Id>
    <Message>Please contact your bank</Message>
    <MessageHeading>Direct Debit Issue</MessageHeading>
    <NotificationType>Finance</NotificationType>
    <Phone i:nil="true" />
    <WebAddress>www.natwest.com</WebAddress>
  </Notification>
  <Notification>
    <Colour>ff3311</Colour>
    <Date>2025-04-03T18:56:54.1932598+01:00</Date>
    <Email i:nil="true" />
    <Id>1</Id>
    <Message>please can you complete a survey from your recent maintenance request</Message>
    <MessageHeading>Complete a survey</MessageHeading>
    <NotificationType>Maintenance</NotificationType>
    <Phone>01173027000</Phone>
    <WebAddress>www.survey.com?flshdflh43lkjhrk34h5kjh4lkrjf</WebAddress>
  </Notification>
</ArrayOfNotification>