alerts API
Description
Alerts API lists the notifications sent to the users. Based on the parameters entered in the Alerts URL, the security token is authenticated and returns all basic Alert details of the user available in the Linchpin application.
Authentication
Security token and origination url, should be sent as response headers for authentication
- Once the Linchpin app is purchased, an interface will be provided to generate the security token which will be unique for a company.
- Alerts API is authenticated based on the company token and external URL from where the request is sent.
URL
The URL structure (path only, no root url) api/v1/Alerts or / Alerts
Method
The request type
GET
Response Codes
Output Response Object
public class NotificationsDto
{
public string Name { get; set; }
public string Email { get; set; }
public string Title { get; set; }
public string SentBy { get; set; }
}
Success Response
Successful request:
{
“status”:200,
"Notification":[{
"Name":"Name",
"Email":"Email",
"Title":"Title",
"SentBy":"SentBy"
},
{
"Name":"Name",
"Email":"Email",
"Title":"Title",
"SentBy":"SentBy"
}]
}
HTTP Status Codes
Most endpoints will have many ways they can fail. From unauthorized access, to wrongful parameters etc.
Example:
Code: 200 OK
Description: { Success }
Code: 401 UNAUTHORIZED
Description: {error: "Authentication credentials were missing or incorrect.”}
Code: 400 Bad Request
Description: { error : "The request was invalid or cannot be otherwise served" }
Code: 404 Not Found
Description: { error : "Alert details not found" }