To utilize this API endpoint, the user will need an access token from a client which has the push message scope.
How to create push message
Example request:
curl -X POST "http://beta-api-ambita.com/kode/v1/distributormessages/distributor/messages"
-H "accept: */*"
-H "Authorization: Bearer <access token>"
-H "Content-Type: application/json" -d
"{ \"message\": \"Meldingen din her\",
\"municipalityNumber\": \"integer\",
\"municipalityName\": \"string\",
\"type\": \"string\"}"
Example response:
{
"id": "8608863f-e39a-4129-83be-c7cfd2701aee",
"message": "This is a test message from create",
"municipalityName": "INFOLAND",
"municipalityNumber": 9999,
"dateCreated": "14-01-2021",
"type": "CUSTOMER"
}
JSON body:
Property | Description | Type: |
|---|---|---|
message | The message content that is going to be sent. | String |
municipalityName | The organization name of who sent the push message. | String |
type | The type of message: CUSTOMER or DISTRIBUTOR. | String |
municipalityNumber | The municipality number of the sender. | String |
dateCreated | The date when the push message was created. | LocalDateTime |
The actual push message that will be sent, will look something like this:
{
"content": {
"body": {
"id": "8608863f-e39a-4129-83be-c7cfd2701aee",
"message": "This is a test message from create",
"municipalityName": "INFOLAND",
"municipalityNumber": 9999,
"dateCreated": "14-01-2021",
"type": "CUSTOMER"
}
},
"eventAction": "Created",
"eventType": "DistributorMessages"
}
How to get list of push messages
Example request:
curl -X GET "http://beta-api-ambita.com/kode/v1/distributormessages/distributor/messages" -H "accept: */*" -H "Authorization: Bearer <Token>"
Example response:
[
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"message": "Dette er et eksempel",
"municipalityName": "INFOLAND",
"municipalityNumber": 9999,
"dateCreated": "14-01-2021",
"type": "CUSTOMER"
},
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"message": "Dette er et eksempel2",
"municipalityName": "INFOLAND",
"municipalityNumber": 9999,
"dateCreated": "14-01-2021",
"type": "CUSTOMER"
}
]