AWRS-NOTIFICATION

This is a placeholder README.md for a new repository

License

This code is open source software licensed under the Apache 2.0 License.

AWRS Notification

AWRS Notification API enables ETMP to push AWRS application status updates and/or changes to the customer resulting in the sending of an email to the applicant.

This API exposes one endpoint to send a templated email.

Resource

POST /:registrationNumber

Example request URI

/awrs-notification/XFAW00000123456

Accepted Media Types

application/json

Path parameters

Request Body parameters

Sample Request

 {
   "name": "first name",
   "email": "[email protected]",
   "status": "04",
   "contact_type": "REJR",
   "contact_number": "123456789012",
   "variation": false
 }

Responses and Error Codes

A successful response returns HTTP 200 without body.

Error Scenarios

Sample Response

Code: 200

Content: No Content

Example Error Response

Code: 400

Content:

  {
   "reason": "Invalid registration number"
  }

AWRS Notification Cache

If the email template and AWRS reference number are valid and the Contact Type is one of either MTRJ, NMRJ, MTRV or NMRV, the notification will be stored to MONGO.

The notification is stored as the following fields,

• registrationNumber
• contactNumber
• contactType
• status

e.g.

   { 
    "registrationNumber" : "XXAW000001234560",
    "contactNumber" : "123456789012",
    "contactType" : "MTRJ",
    "status" : "04"
   }

To retrieve a notification from MONGO you can call the endpoint as follows,

Resource

GET /cache/:registrationNumber

Example request URI

/awrs-notification/cache/XFAW00000123456

Accepted Media Types

application/json

Path parameters

Responses and Error Codes

A successful response returns HTTP 200 with a JSON body containing the following fields,

• registrationNumber
• contactNumber
• contactType
• status

e.g.

   { 
    "registrationNumber" : "XXAW000001234560",
    "contactNumber" : "123456789012",
    "contactType" : "MTRJ",
    "status" : "04"
   }

To delete a notification from MONGO you can call the endpoint as follows,

Resource

DELETE /cache/:registrationNumber

Example request URI

/awrs-notification/cache/XFAW00000123456

Accepted Media Types

Not required - DO NOT specify application/json as it will give a Bad Request when calling the DELETE

Path parameters

Responses and Error Codes

A successful response returns HTTP 200 without body.

AWRS Notification Viewed Status

When a notification is POSTed and if the email template and AWRS reference number are valid a corresponding notification viewed status will be stored in MONGO. It will be set to 'false' to indicate that it is new and not yet viewed. The frontend application is responsible for calling the PUT endpoint once the notification has been viewed, this will update the flag in MONGO and cause the GET endpoint to return 'true'.

The notification viewed status is stored in MONGO with the following fields,

• registrationNumber
• viewed

e.g.

   { 
    "registrationNumber" : "XXAW000001234560",
    "viewed" : false
   }

To retrieve a notification viewed status from MONGO you can call the endpoint as follows,

Resource

GET /cache/viewed/:registrationNumber

Example request URI

/awrs-notification/cache/viewed/XFAW00000123456

Accepted Media Types

application/json

Path parameters

Responses and Error Codes

A successful response returns HTTP 200 with a JSON body containing the following field,

• viewed

e.g.

   { 
    "viewed" : false
   }

To update a notification viewed status in MONGO and set it to 'true' you can call the endpoint as follows (note, no body is required as the status is always set to 'true'),

Resource

PUT /cache/viewed/:registrationNumber

Example request URI

/awrs-notification/cache/viewed/XFAW00000123456

Accepted Media Types

Not required - DO NOT specify application/json as it will give a Bad Request when calling the PUT

Path parameters

Responses and Error Codes

A successful response returns HTTP 200 without body.