Get a Notification

The following details are taken from the documentation available on https://spportal.mycas.org.uk

This service is used to get the details of a single notification. The notification details which are sent to an organization once will be marked as sent ,  the details of sent notification can be fetched again until they have been acknowledged.

Guidance

• A notification that has been fetched will be marked as sent
• The details of the notification can be fetched anytime irrespective of the status using the ID and Type

Request

requires a Notification ID and a Notification Type Code

Valid notificationtypecodes

• REGISTRATION_NOTIFICATION
• CHANGE_PERSONAL_DETAILS_NOTIFICATION
• CHANGE_ADDRESS_NOTIFICATION
• DEATH_NOTIFICATION
• DEATH_NOTIFICATION_WITH_ADDITIONAL_DETAILS
• UCRN_RESOLUTION_NOTIFICATION
• UPRN_RESOLUTION_NOTIFICATION
• NEC_CARD_NOTIFICATION
• DEATH_CORRECTION_NOTIFICATION
• MERGE_UCRN_NOTIFICATION
• SWAP_UCRN_NOTIFICATION
• DELETE_UCRN_NOTIFICATION
• CHANGE_CONTACT_DETAILS_NOTIFICATION

Example

{
  "method":"GetNotificationByID",
  "params":{
    "notificationid":"12345678",
    "notificationtypecode":"UPRN_RESOLUTION_NOTIFICATION",
    "callertoken":"YourCallerToken"
    },
  "id":"12",
  "jsonrpc": "2.0"
}

ResponseBody

Individual Notification fields will be returned based on the NotificationTypeCode passed in RequestBody all responses will contain a notificationTypeCode and a notificationID.

RegistrationNotification

• UCRN
  • value- UCRN of matched Citizen Details provided in Request
  • ucrnType - Type of UCRN assigned.
• CitizenDetails
  • title
  • mame
    • firstname
    • middlename
    • lastname
  • gender
  • dateOfBirth
• preferredName
  • preferredFirstname
  • preferredMiddlename
  • preferredLastname
• contact
  • mobileNumber
  • landlineNumber
  • emailAddress
• UPRN
  • value UPRN of the Matched Address provided in Request
  • UPRNType
• address
  • addressLine
    • addressLine1
    • addressLine2
    • addressLine3
  • town
  • postCode
  • laCode
• LoA

ChangePersonalDetailsNotification

• UCRN
  • value- UCRN of matched Citizen Details provided in Request
  • ucrnType - Type of UCRN assigned.
• CitizenDetails
  • title
  • mame
    • firstname
    • middlename
    • lastname
  • gender
  • dateOfBirth
• preferredName
  • preferredFirstname
  • preferredMiddlename
  • preferredLastname
• LoA

ChangeAddressNotification

• UCRN
  • value- UCRN of matched Citizen Details provided in Request
  • ucrnType - Type of UCRN assigned.
• UPRN
  • value UPRN of the Matched Address provided in Request
  • UPRNType
• address
  • addressLine
    • addressLine1
    • addressLine2
    • addressLine3
  • town
  • postCode
  • laCode
• ChangeAddressActionFlag (P,S or D)

DeathNotification

• UCRN
  • value- UCRN of matched Citizen Details provided in Request
  • ucrnType - Type of UCRN assigned.
• dateOfDeath

DeathNotificationWithAdditionalDetails

• UCRN
  • value- UCRN of matched Citizen Details provided in Request
  • ucrnType - Type of UCRN assigned.
• basicCitizenDetails
  • name
    • firstname
    • middlename
    • lastname
  • gender
  • dateOfBirth
  • dateOfDeath
  • placeOfBirth
  • mothersBirthSurname
• UPRN
  • value UPRN of the Matched Address provided in Request
  • UPRNType
• address
  • addressLine
    • addressLine1
    • addressLine2
    • addressLine3
  • town
  • postCode
  • laCode
• LoA

DeathCorrectionNotification

• UCRN
  • value- UCRN of matched Citizen Details provided in Request
  • ucrnType - Type of UCRN assigned.

UCRNResolutionNotification

• UCRN
  • value- UCRN of matched Citizen Details provided in Request
  • ucrnType - Type of UCRN assigned.
• NewUCRN
  • value- UCRN of matched Citizen Details provided in Request
  • ucrnType - Type of UCRN assigned.

MergeUCRNNotification

• OldUCRN
  • value- UCRN of matched Citizen Details provided in Request
  • ucrnType - Type of UCRN assigned.
• NewUCRN
  • value- UCRN of matched Citizen Details provided in Request
  • ucrnType - Type of UCRN assigned.

SwapUCRNNotification

• OldUCRN
  • value- UCRN of matched Citizen Details provided in Request
  • ucrnType - Type of UCRN assigned.
• NewUCRN
  • value- UCRN of matched Citizen Details provided in Request
  • ucrnType - Type of UCRN assigned.

DeleteUCRNNotification

• UCRN
  • value- UCRN of matched Citizen Details provided in Request
  • ucrnType - Type of UCRN assigned.

UPRNResolutionNotification

• UPRN
  • value UPRN of the Matched Address provided in Request
  • UPRNType
• NewUPRN
  • value UPRN of the Matched Address provided in Request
  • UPRNType

NECCardNotification

• UCRN
  • value- UCRN of matched Citizen Details provided in Request
  • ucrnType - Type of UCRN assigned.
• NECCard
  • NECCardNumber
  • isYoungScotOptOut
  • deactiveDate
• citizenProofs
  • identityProofs (Array)
  • addressProfs (Array)
• NECCardActionFlag (C or H)

ChangeContactDetailsNotification

• UCRN
  • value- UCRN of matched Citizen Details provided in Request
  • ucrnType - Type of UCRN assigned.
• contact
  • mobileNumber
  • landlineNumber
  • emailAddress

Response Codes