Notifications API (v9.1)

Download OpenAPI specification:Download

Artionet: support@artionet.com URL: https://www.artionet.ch/

Welcome to the Notifications API documentation.

You can test the API using Swagger.

You can find a detailed documentation by following this link.

Notifications

Get a single notification

Allows to retrieve a specific notifiation identified by its Id.

path Parameters

notificationId

required

integer <int32>

ID of the notification

Responses

Response samples

200
404
422

Content type

application/json

{"notificationId": 0,
"recipientId": "string",
"sendEmail": true,
"sendPush": true,
"sendSms": true,
"email": "string",
"phoneNumber": "string",
"subject": "string",
"msgLong": "string",
"msgShort": "string",
"linkToGv": "string",
"receiptStamp": "2019-08-24T14:15:22Z",
"completionStamp": "2019-08-24T14:15:22Z",
"processingStatus": "Error",
"businessCaseId": "fad1f347-b9ed-4ee1-a340-bb8bf74c95bf"
}

Delete an existing notification

Allows to delete an existing notifiation identified by its Id.

path Parameters

notificationId

required

integer <int32>

ID of the notification to delete

Responses

Response samples

404
422

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"traceId": "729bb1bf-882d-483b-89d3-5855dc5af3aa",
"property1": null,
"property2": null
}

Get list of notifications

Allows to retrieve a list of notifications (GET only) according to certain criteria.

query Parameters

RecipientId required	string Filter notification by `RecipientId` property
BusinessCaseId	string <uuid> Filter notifiation by `BusinessCaseId` property
SearchTerm	string Term searched in notification `MsgLong`, `MsgShort` and `Subject`
ProcessingStatus	string Enum: "Error" "ToProcess" "Processing" "Processed" "ProcessedFallback" Filter notification by `ProcessingStatus` property
MinReceiptStamp	string <date-time> Filter notification with a later or equal `ReceiptStamp`
MaxReceiptStamp	string <date-time> Filter notification with a earlier or equal `ReceiptStamp`
MinCompletionStamp	string <date-time> Filter notification with a later or equal `CompletionStamp`
MaxCompletionStamp	string <date-time> Filter notification with a earlier or equal `CompletionStamp`
PageNumber	integer <int32> [ 1 .. 2147483647 ] Page number to retrieve
PageSize	integer <int32> Number of notifications per page
OrderBy	string Sorting option. Usage (no square brackets !) : `orderBy=[property] [asc,desc],[property] [asc,desc],...`

Responses

Response samples

200
422

Content type

application/json

[{"notificationId": 0,
"recipientId": "string",
"sendEmail": true,
"sendPush": true,
"sendSms": true,
"email": "string",
"phoneNumber": "string",
"subject": "string",
"msgLong": "string",
"msgShort": "string",
"linkToGv": "string",
"receiptStamp": "2019-08-24T14:15:22Z",
"completionStamp": "2019-08-24T14:15:22Z",
"processingStatus": "Error",
"businessCaseId": "fad1f347-b9ed-4ee1-a340-bb8bf74c95bf"
}
]

Get list of notifications

Allows to retrieve a list of notifications (GET only) according to certain criteria.

query Parameters

RecipientId required	string Filter notification by `RecipientId` property
BusinessCaseId	string <uuid> Filter notifiation by `BusinessCaseId` property
SearchTerm	string Term searched in notification `MsgLong`, `MsgShort` and `Subject`
ProcessingStatus	string Enum: "Error" "ToProcess" "Processing" "Processed" "ProcessedFallback" Filter notification by `ProcessingStatus` property
MinReceiptStamp	string <date-time> Filter notification with a later or equal `ReceiptStamp`
MaxReceiptStamp	string <date-time> Filter notification with a earlier or equal `ReceiptStamp`
MinCompletionStamp	string <date-time> Filter notification with a later or equal `CompletionStamp`
MaxCompletionStamp	string <date-time> Filter notification with a earlier or equal `CompletionStamp`
PageNumber	integer <int32> [ 1 .. 2147483647 ] Page number to retrieve
PageSize	integer <int32> Number of notifications per page
OrderBy	string Sorting option. Usage (no square brackets !) : `orderBy=[property] [asc,desc],[property] [asc,desc],...`

Responses

Response samples

200
422

Content type

application/json

[{"notificationId": 0,
"recipientId": "string",
"sendEmail": true,
"sendPush": true,
"sendSms": true,
"email": "string",
"phoneNumber": "string",
"subject": "string",
"msgLong": "string",
"msgShort": "string",
"linkToGv": "string",
"receiptStamp": "2019-08-24T14:15:22Z",
"completionStamp": "2019-08-24T14:15:22Z",
"processingStatus": "Error",
"businessCaseId": "fad1f347-b9ed-4ee1-a340-bb8bf74c95bf"
}
]

Gets the allowed HTTP Methods for URI

Allows to know which methods are allowed for this URI.

Responses

Create a new notification

Allows to create a new notification.

Request Body schema: application/json

Notification to create

recipientId required	string [ 1 .. 50 ] characters ID of the notification recipient
sendEmail	boolean or null Indicates whether the notification is to be sent by e-mail
sendPush	boolean or null Indicates whether the notification is to be sent by Web Push
sendSms	boolean or null Indicates whether the notification is to be sent by SMS
email required	string <email> [ 1 .. 255 ] characters Recipient e-mail
phoneNumber	string or null <= 50 characters Recipient phone number
subject required	string [ 1 .. 255 ] characters Notification subject
msgLong	string or null Notification message (long version)
msgShort	string or null <= 255 characters Notification message (short version)
linkToGv	string or null <uri> Link to redirect to eGuichet when clicking on the push notification
businessCaseId	string or null <uuid> Business case's GUID identifier
isSkippable required	boolean Flag indicating if the notification has to be sent
serviceId	integer or null <int32> Service Id
	Array of objects or null (PushForCreationDto) List of devices that will receive the notification

Responses

Request samples

Payload

Content type

application/json

{"recipientId": "string",
"sendEmail": true,
"sendPush": true,
"sendSms": true,
"email": "user@example.com",
"phoneNumber": "string",
"subject": "string",
"msgLong": "string",
"msgShort": "string",
"linkToGv": "http://example.com",
"businessCaseId": "fad1f347-b9ed-4ee1-a340-bb8bf74c95bf",
"isSkippable": true,
"serviceId": 0,
"devices": [{"endpoint": "string",
"keyP256dh": "string",
"keyAuth": "string"
}
]
}

Response samples

400
422

Content type

application/json

{"errors": {"property1": ["string"
],
"property2": ["string"
]
},
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

Delete notification by criteria

Allows to delete existing notifiations by criteria.

query Parameters

RecipientId

required

string

ID of the notification recipient

Responses

Response samples

422

Content type

application/json

{"errors": {"property1": ["string"
],
"property2": ["string"
]
},
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

Templates

Get a single e-mail template

Allows to retrieve a specific template identified by its Id.

path Parameters

templateId

required

integer <int32>

ID of the template

Responses

Response samples

200
404
422

Content type

application/json

{"id": 0,
"name": "string",
"description": "string",
"type": "MASTER",
"subject": "string",
"value": "string",
"language": "string",
"serviceId": 0,
"senderId": "string",
"isEnabled": true,
"score": 0,
"createdBy": "string",
"createStamp": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"updateStamp": "2019-08-24T14:15:22Z"
}

Update an e-mail template

Allows to update (all properties) an existing template.

path Parameters

templateId

required

integer <int32>

E-mail template Id

Request Body schema: application/json

Updated template

name required	string non-empty Name of template
description	string or null <= 255 characters Description of template to indicates the purpose of the template
type required	string Enum: "MASTER" "COMPONENT" Type of the template. The type can be MASTER or COMPONENT
subject	string or null The tempalte subject (e-mail/notification subject)
value required	string non-empty The template itself (e-mail body) in HTML
language	string or null <= 2 characters 2 letters ISO 639-1 language of the template
serviceId	integer or null <int32> The identifier of the iGovPortal service to which the template is associated
senderId	string or null <= 50 characters The identifier of the sender (canton, town, ...) to wich the template is associated
isEnabled required	boolean Indicates if the template can be used (active)
updatedBy required	string [ 1 .. 100 ] characters Author of the last update of the template

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"type": "MASTER",
"subject": "string",
"value": "string",
"language": "st",
"serviceId": 0,
"senderId": "string",
"isEnabled": true,
"updatedBy": "string"
}

Response samples

200
400
404
422

Content type

application/json

{"id": 0,
"name": "string",
"description": "string",
"type": "MASTER",
"subject": "string",
"value": "string",
"language": "string",
"serviceId": 0,
"senderId": "string",
"isEnabled": true,
"score": 0,
"createdBy": "string",
"createStamp": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"updateStamp": "2019-08-24T14:15:22Z"
}

Delete a existing e-mail template

Allows to delete an existing e-mail template identified by its Id and all of its previous versions.

path Parameters

templateId

required

integer <int32>

ID of the template to delete

Responses

Response samples

404
422

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"traceId": "729bb1bf-882d-483b-89d3-5855dc5af3aa",
"property1": null,
"property2": null
}

Get list of e-mail templates

Allows to retrieve a list of templates according to certain criteria.

query Parameters

IsEnabled	boolean Filtre templates by `IsEnabled` property.
Type	string Enum: "MASTER" "COMPONENT" Filtre templates by `Type` property. Avalaible value : `MASTER`, `COMPONENT`.
IsEvaluationEnabled	boolean Default: false Enable the computation of templates score regarding the provided criteria.
Name	string Filter templates by `Name` property.
Language	string Filtre templates by `Language` property. This filtre is also a criteria for template computation.
SenderId	string Filtre templates by `SenderId` property. This filtre is also a criteria for template computation.
ServiceId	integer <int32> Filtre templates by `ServiceId` property. This filtre is also a criteria for template computation.
PageNumber	integer <int32> [ 1 .. 2147483647 ] Page number to retrieve
PageSize	integer <int32> Number of notifications per page
OrderBy	string Sorting option. Usage (no square brackets !) : `orderBy=[property] [asc,desc],[property] [asc,desc],...`

Responses

Response samples

200
422

Content type

application/json

[{"id": 0,
"name": "string",
"description": "string",
"type": "MASTER",
"subject": "string",
"value": "string",
"language": "string",
"serviceId": 0,
"senderId": "string",
"isEnabled": true,
"score": 0,
"createdBy": "string",
"createStamp": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"updateStamp": "2019-08-24T14:15:22Z"
}
]

Get list of e-mail templates

Allows to retrieve a list of templates according to certain criteria.

query Parameters

IsEnabled	boolean Filtre templates by `IsEnabled` property.
Type	string Enum: "MASTER" "COMPONENT" Filtre templates by `Type` property. Avalaible value : `MASTER`, `COMPONENT`.
IsEvaluationEnabled	boolean Default: false Enable the computation of templates score regarding the provided criteria.
Name	string Filter templates by `Name` property.
Language	string Filtre templates by `Language` property. This filtre is also a criteria for template computation.
SenderId	string Filtre templates by `SenderId` property. This filtre is also a criteria for template computation.
ServiceId	integer <int32> Filtre templates by `ServiceId` property. This filtre is also a criteria for template computation.
PageNumber	integer <int32> [ 1 .. 2147483647 ] Page number to retrieve
PageSize	integer <int32> Number of notifications per page
OrderBy	string Sorting option. Usage (no square brackets !) : `orderBy=[property] [asc,desc],[property] [asc,desc],...`

Responses

Response samples

200
422

Content type

application/json

[{"id": 0,
"name": "string",
"description": "string",
"type": "MASTER",
"subject": "string",
"value": "string",
"language": "string",
"serviceId": 0,
"senderId": "string",
"isEnabled": true,
"score": 0,
"createdBy": "string",
"createStamp": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"updateStamp": "2019-08-24T14:15:22Z"
}
]

Create a new e-mail template

Allows to create a new e-mail template.

Request Body schema: application/json

Template to create

name required	string non-empty Name of template
description	string or null <= 255 characters Description of template to indicates the purpose of the template
type required	string Enum: "MASTER" "COMPONENT" Type of the template
subject	string or null The tempalte subject (e-mail/notification subject)
value required	string non-empty The template itself (e-mail body) in HTML
language	string or null <= 2 characters 2 letters ISO 639-1 language of the template
serviceId	integer or null <int32> The identifier of the iGovPortal service to which the template is associated
senderId	string or null <= 50 characters The identifier of the sender (canton, town, ...) to wich the template is associated
isEnabled	boolean Default: true Indicates if the template can be used (active)
createdBy required	string [ 1 .. 100 ] characters Author of the template

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"type": "MASTER",
"subject": "string",
"value": "string",
"language": "st",
"serviceId": 0,
"senderId": "string",
"isEnabled": true,
"createdBy": "string"
}

Response samples

201
400
422

Content type

application/json

{"id": 0,
"name": "string",
"description": "string",
"type": "MASTER",
"subject": "string",
"value": "string",
"language": "string",
"serviceId": 0,
"senderId": "string",
"isEnabled": true,
"score": 0,
"createdBy": "string",
"createStamp": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"updateStamp": "2019-08-24T14:15:22Z"
}

Restore the previous version of a specific template

Allows restore previous version of an existing the template.

path Parameters

templateId

required

integer <int32>

Request Body schema: application/json

updatedBy

required

string [ 1 .. 100 ] characters

Author of the restoration

Responses

Request samples

Payload

Content type

application/json

{"updatedBy": "string"
}

Response samples

200
400
404
422

Content type

application/json

{"id": 0,
"name": "string",
"description": "string",
"type": "MASTER",
"subject": "string",
"value": "string",
"language": "string",
"serviceId": 0,
"senderId": "string",
"isEnabled": true,
"score": 0,
"createdBy": "string",
"createStamp": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"updateStamp": "2019-08-24T14:15:22Z"
}

Create (rendering) a new e-mail content

Allows to create/render a new e-mail template.

Request Body schema: application/json

Template data for rendering

language	string E-mail language
serviceId	integer or null <int32> Service identifier to which the e-mail is attached
senderId	string or null Sender (town, departement, ...) identifier to which the e-mail is attached
	object or null Data that can be injected into e-mail templates

Responses

Request samples

Payload

Content type

application/json

{"language": "string",
"serviceId": 0,
"senderId": "string",
"templateData": {"serviceName": "string",
"serviceLink": {"linkUrl": "string",
"iconUrl": "string"
},
"recipient": {"gender": "Unknown",
"firstname": "string",
"lastname": "string",
"organizationName": "string"
},
"subject": "string",
"body": "string",
"uiPortalTemplateName": "string",
"businessCase": {"status": "string",
"processingTimeInHours": 0,
"lastUpdateStamp": "2019-08-24T14:15:22Z",
"actionUrl": "string",
"actionMessage": "string",
"actionButtonText": "string"
},
"shoppingCart": {"totalPrice": 0.1,
"items": [{"name": "string",
"quantity": 0,
"price": 0.1
}
]
},
"serviceSteps": {"previousSteps": [{"name": "string",
"description": "string",
"processingTimeInHours": 0,
"iconUrl": "string",
"actionUrl": "string",
"createStamp": "2019-08-24T14:15:22Z",
"updateStamp": "2019-08-24T14:15:22Z",
"sortOrder": 0
}
],
"currentSteps": [{"name": "string",
"description": "string",
"processingTimeInHours": 0,
"iconUrl": "string",
"actionUrl": "string",
"createStamp": "2019-08-24T14:15:22Z",
"updateStamp": "2019-08-24T14:15:22Z",
"sortOrder": 0
}
],
"nextSteps": [{"name": "string",
"description": "string",
"processingTimeInHours": 0,
"iconUrl": "string",
"actionUrl": "string",
"createStamp": "2019-08-24T14:15:22Z",
"updateStamp": "2019-08-24T14:15:22Z",
"sortOrder": 0
}
]
},
"documentLinks": [{"name": "string",
"url": "string"
}
],
"messageLink": "string",
"metaData": {"property1": "string",
"property2": "string"
}
}
}

Response samples

200
400
422

Content type

application/json

{"language": "string",
"serviceId": 0,
"senderId": "string",
"subject": "string",
"renderedEmail": "string"
}

Channels

Get a single global channel

Allows to retrieve a specific channel identified by its Name.

path Parameters

channelName

required

string

Name of the channel

Responses

Response samples

200
404
422

Content type

application/json

{"id": 0,
"name": "string",
"description": "string",
"isEnabled": true,
"createdBy": "string",
"createStamp": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"updateStamp": "2019-08-24T14:15:22Z"
}

Update a global channel

Allows to update an existing global channel.

path Parameters

channelName

required

string

Name of the channel to update

Request Body schema: application/json

Updated channel

name required	string [ 1 .. 100 ] characters Unique name of the channel
description required	string [ 1 .. 255 ] characters Short description of the channel
isEnabled	boolean Default: true Indicates if the channel is available globally
updatedBy required	string [ 1 .. 100 ] characters Author of the last update of the template

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"isEnabled": true,
"updatedBy": "string"
}

Response samples

200
400
404
422

Content type

application/json

{"id": 0,
"name": "string",
"description": "string",
"isEnabled": true,
"createdBy": "string",
"createStamp": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"updateStamp": "2019-08-24T14:15:22Z"
}

Delete an existing channel

Allows to delete an existing channel identified by its Name, and all its relations.

path Parameters

channelName

required

string

Name of the channel to delete

Responses

Response samples

404
422

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"traceId": "729bb1bf-882d-483b-89d3-5855dc5af3aa",
"property1": null,
"property2": null
}

Get a list of global channels

Allows to retrieve a list of global channels according to certain criteria.

query Parameters

PageNumber	integer <int32> [ 1 .. 2147483647 ] Page number to retrieve
PageSize	integer <int32> Number of notifications per page
OrderBy	string Sorting option. Usage (no square brackets !) : `orderBy=[property] [asc,desc],[property] [asc,desc],...`

Responses

Response samples

200
422

Content type

application/json

[{"id": 0,
"name": "string",
"description": "string",
"isEnabled": true,
"createdBy": "string",
"createStamp": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"updateStamp": "2019-08-24T14:15:22Z"
}
]

Create a new global channel

Allows to create a global channel.

Request Body schema: application/json

Global channel to create

name required	string [ 1 .. 100 ] characters Unique name of the channel
description required	string [ 1 .. 255 ] characters Short description of the channel
isEnabled	boolean Default: true Indicates if the channel is available globally
createdBy required	string [ 1 .. 100 ] characters Author of the channel

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"isEnabled": true,
"createdBy": "string"
}

Response samples

201
400
422

Content type

application/json

{"id": 0,
"name": "string",
"description": "string",
"isEnabled": true,
"createdBy": "string",
"createStamp": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"updateStamp": "2019-08-24T14:15:22Z"
}

Profiles

Get a single push subscription for a specific profile

Allows to retrieve a specific push subscription identified by its id for the provided profile.

path Parameters

profileId required	integer <int32> `Id` of the profile
pushId required	integer <int32> `Id` of the push subscription

Responses

Response samples

200
404
422

Content type

application/json

{"id": 0,
"profileId": 0,
"description": "string",
"endpoint": "string",
"keyP256dh": "string",
"keyAuth": "string",
"createdBy": "string",
"createStamp": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"updateStamp": "2019-08-24T14:15:22Z"
}

Update a push subscription for a specific profile

Allows to update an existing push subscription for the specified profile.

path Parameters

profileId required	integer <int32> `Id` of the profile
pushId required	integer <int32> `Id` of the push subscription

Request Body schema: application/json

Updated push subscription

description	string or null <= 100 characters Short description of the push subscription
endpoint	string or null <= 1800 characters Endpoint associated with the push subscription
keyP256dh	string or null <= 200 characters An Elliptic curve Diffie–Hellman public key on the P-256 curve associated with the push subscription
keyAuth	string or null <= 50 characters An authentication secret associated with the push subscription
updatedBy required	string [ 1 .. 100 ] characters Author of the last update of the push subscription

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"endpoint": "string",
"keyP256dh": "string",
"keyAuth": "string",
"updatedBy": "string"
}

Response samples

200
400
404
422

Content type

application/json

{"id": 0,
"profileId": 0,
"description": "string",
"endpoint": "string",
"keyP256dh": "string",
"keyAuth": "string",
"createdBy": "string",
"createStamp": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"updateStamp": "2019-08-24T14:15:22Z"
}

Delete an existing push subscription for a specific profile

Allows to delete an existing push subscription identified by its Id for the provided profile.

path Parameters

profileId required	integer <int32> `Id` of the profile
pushId required	integer <int32> `Id` of the push subscription

Responses

Response samples

404
422

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"traceId": "729bb1bf-882d-483b-89d3-5855dc5af3aa",
"property1": null,
"property2": null
}

Get list of push subscriptions for a specific profile

Allows to retrieve a list of push subscriptions for the specified profile according to certain criteria.

path Parameters

profileId

required

integer <int32>

Id of the profile

query Parameters

PageNumber	integer <int32> [ 1 .. 2147483647 ] Page number to retrieve
PageSize	integer <int32> Number of notifications per page
OrderBy	string Sorting option. Usage (no square brackets !) : `orderBy=[property] [asc,desc],[property] [asc,desc],...`

Responses

Response samples

200
422

Content type

application/json

[{"id": 0,
"profileId": 0,
"description": "string",
"endpoint": "string",
"keyP256dh": "string",
"keyAuth": "string",
"createdBy": "string",
"createStamp": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"updateStamp": "2019-08-24T14:15:22Z"
}
]

Create a new push subscription for a specific profile

Allows to create a push subscription for the specified profile.

path Parameters

profileId

required

integer <int32>

Id of the profile

Request Body schema: application/json

Push subscription to create

description required	string [ 1 .. 100 ] characters Short description of the push subscription
endpoint	string or null <= 1800 characters Endpoint associated with the push subscription
keyP256dh	string or null <= 200 characters An Elliptic curve Diffie–Hellman public key on the P-256 curve associated with the push subscription
keyAuth	string or null <= 50 characters An authentication secret associated with the push subscription
createdBy required	string [ 1 .. 100 ] characters Author of the push subscription

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"endpoint": "string",
"keyP256dh": "string",
"keyAuth": "string",
"createdBy": "string"
}

Response samples

201
400
422

Content type

application/json

{"id": 0,
"profileId": 0,
"description": "string",
"endpoint": "string",
"keyP256dh": "string",
"keyAuth": "string",
"createdBy": "string",
"createStamp": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"updateStamp": "2019-08-24T14:15:22Z"
}

Delete all push subscriptions for a specific profile

Allows to delete all push subscriptions of the specified profile.

path Parameters

profileId

required

integer <int32>

Id of the profile

Responses

Response samples

422

Content type

application/json

{"errors": {"property1": ["string"
],
"property2": ["string"
]
},
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

Get a specific channel within a specific profile

Allows to retrieve a specific channel and its relation with a specific profile.

path Parameters

profileId required	integer <int32> `Id` of the profile
channelName required	string `Name` of the channel

Responses

Response samples

200
404
422

Content type

application/json

{"id": 0,
"name": "string",
"description": "string",
"isEnabled": true,
"createdBy": "string",
"createStamp": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"updateStamp": "2019-08-24T14:15:22Z",
"profileChannel": {"id": 0,
"profileId": 0,
"channelId": 0,
"isEnabled": true,
"createdBy": "string",
"createStamp": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"updateStamp": "2019-08-24T14:15:22Z"
}
}

Add/update the relation between the specified Channel and Profile

Allows to create a profile channel.

path Parameters

profileId required	integer <int32> `Id` of the profile
channelName required	string `Name` of the channel

Request Body schema: application/json

Profile channel to create

isEnabled	boolean Default: true Indicates if the channel is available globally
createdBy required	string [ 1 .. 100 ] characters Author of the channel

Responses

Request samples

Payload

Content type

application/json

{"isEnabled": true,
"createdBy": "string"
}

Response samples

201
400
404
422

Content type

application/json

{"id": 0,
"profileId": 0,
"channelId": 0,
"isEnabled": true,
"createdBy": "string",
"createStamp": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"updateStamp": "2019-08-24T14:15:22Z"
}

Get the list of channels within a specific profile

Allows to retrieve a list of profile channels according to certain criteria.

path Parameters

profileId

required

integer <int32>

Id of the profile

query Parameters

IsEnabled	boolean Indicates if the global channel is available
PageNumber	integer <int32> [ 1 .. 2147483647 ] Page number to retrieve
PageSize	integer <int32> Number of notifications per page
OrderBy	string Sorting option. Usage (no square brackets !) : `orderBy=[property] [asc,desc],[property] [asc,desc],...`

Responses

Response samples

200
422

Content type

application/json

[{"id": 0,
"name": "string",
"description": "string",
"isEnabled": true,
"createdBy": "string",
"createStamp": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"updateStamp": "2019-08-24T14:15:22Z",
"profileChannel": {"id": 0,
"profileId": 0,
"channelId": 0,
"isEnabled": true,
"createdBy": "string",
"createStamp": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"updateStamp": "2019-08-24T14:15:22Z"
}
}
]

Delete all existing relations between channels and a specific profile

Allows to delete all channels associated to the specified profile.

path Parameters

profileId

required

integer <int32>

Id of the profile

Responses

Response samples

422

Content type

application/json

{"errors": {"property1": ["string"
],
"property2": ["string"
]
},
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

Get a specific muted service for a specific profile-channel

Allows to retrieve a specific muted service for a specific profile-channel.

path Parameters

profileId required	integer <int32> `Id` of the profile
channelName required	string `Name` of the channel
serviceId required	integer <int32> `Id` of the service

Responses

Response samples

200
404
422

Content type

application/json

{"id": 0,
"profileChannelId": 0,
"serviceId": 0,
"channelId": 0,
"channelName": "string",
"createdBy": "string",
"createStamp": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"updateStamp": "2019-08-24T14:15:22Z"
}

Add/update a specific service as muted for a specific profile-channel

Allows to add/update a muted service for a specific profile-channel.

path Parameters

profileId required	integer <int32> `Id` of the profile
channelName required	string `Name` of the channel
serviceId required	integer <int32> `Id` of the service

Request Body schema: application/json

Profile channel to create

createdBy

required

string [ 1 .. 100 ] characters

Author of the muted service

Responses

Request samples

Payload

Content type

application/json

{"createdBy": "string"
}

Response samples

201
400
404
422

Content type

application/json

{"id": 0,
"profileChannelId": 0,
"serviceId": 0,
"channelId": 0,
"channelName": "string",
"createdBy": "string",
"createStamp": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"updateStamp": "2019-08-24T14:15:22Z"
}

Delete an muted service for a specific profile-channel

Allows to delete an existing muted service for a specific profile-channel

path Parameters

profileId required	integer <int32> `Id` of the profile
channelName required	string `Name` of the channel
serviceId required	integer <int32> `Id` of the service

Responses

Response samples

404
422

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"traceId": "729bb1bf-882d-483b-89d3-5855dc5af3aa",
"property1": null,
"property2": null
}

Get the list of muted services for a specific profile

Allows to retrieve a list of profile channels according to certain criteria.

path Parameters

profileId

required

integer <int32>

Id of the profile

query Parameters

PageNumber	integer <int32> [ 1 .. 2147483647 ] Page number to retrieve
PageSize	integer <int32> Number of notifications per page
OrderBy	string Sorting option. Usage (no square brackets !) : `orderBy=[property] [asc,desc],[property] [asc,desc],...`

Responses

Response samples

200
422

Content type

application/json

[{"id": 0,
"profileChannelId": 0,
"serviceId": 0,
"channelId": 0,
"channelName": "string",
"createdBy": "string",
"createStamp": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"updateStamp": "2019-08-24T14:15:22Z"
}
]

Delete all existing muted services for a specific profile

Allows to delete all muted services to the specified profile.

path Parameters

profileId

required

integer <int32>

Id of the profile

Responses

Response samples

422

Content type

application/json

{"errors": {"property1": ["string"
],
"property2": ["string"
]
},
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

Notification Model

notificationId	integer <int32> Unique ID of the notification
recipientId	string ID of the notification recipient
sendEmail	boolean Indicates whether the notification is to be sent by e-mail
sendPush	boolean Indicates whether the notification is to be sent by Web Push
sendSms	boolean Indicates whether the notification is to be sent by SMS
email	string Recipient e-mail
phoneNumber	string or null Recipient phone number
subject	string Notification subject
msgLong	string or null Notification message (long version)
msgShort	string or null Notification message (short version)
linkToGv	string or null Link to redirect to eGuichet when clicking on the push notification
receiptStamp	string <date-time> Date of receipt/creation of the notification
completionStamp	string or null <date-time> Date of completion of the sending of the notification on the various channels.
processingStatus	string Enum: "Error" "ToProcess" "Processing" "Processed" "ProcessedFallback" Notification processing status (ToProcess, Processing, Processed, ProcessedFallback, Error)
businessCaseId	string or null <uuid> Business case's GUID identifier

{"notificationId": 0,
"recipientId": "string",
"sendEmail": true,
"sendPush": true,
"sendSms": true,
"email": "string",
"phoneNumber": "string",
"subject": "string",
"msgLong": "string",
"msgShort": "string",
"linkToGv": "string",
"receiptStamp": "2019-08-24T14:15:22Z",
"completionStamp": "2019-08-24T14:15:22Z",
"processingStatus": "Error",
"businessCaseId": "fad1f347-b9ed-4ee1-a340-bb8bf74c95bf"
}

Notification Creation Model

recipientId required	string [ 1 .. 50 ] characters ID of the notification recipient
sendEmail	boolean or null Indicates whether the notification is to be sent by e-mail
sendPush	boolean or null Indicates whether the notification is to be sent by Web Push
sendSms	boolean or null Indicates whether the notification is to be sent by SMS
email required	string <email> [ 1 .. 255 ] characters Recipient e-mail
phoneNumber	string or null <= 50 characters Recipient phone number
subject required	string [ 1 .. 255 ] characters Notification subject
msgLong	string or null Notification message (long version)
msgShort	string or null <= 255 characters Notification message (short version)
linkToGv	string or null <uri> Link to redirect to eGuichet when clicking on the push notification
businessCaseId	string or null <uuid> Business case's GUID identifier
isSkippable required	boolean Flag indicating if the notification has to be sent
serviceId	integer or null <int32> Service Id
	Array of objects or null (PushForCreationDto) List of devices that will receive the notification

{"recipientId": "string",
"sendEmail": true,
"sendPush": true,
"sendSms": true,
"email": "user@example.com",
"phoneNumber": "string",
"subject": "string",
"msgLong": "string",
"msgShort": "string",
"linkToGv": "http://example.com",
"businessCaseId": "fad1f347-b9ed-4ee1-a340-bb8bf74c95bf",
"isSkippable": true,
"serviceId": 0,
"devices": [{"endpoint": "string",
"keyP256dh": "string",
"keyAuth": "string"
}
]
}

Push Creation Model

endpoint	string or null Endpoint associated with the push subscription
keyP256dh	string or null An Elliptic curve Diffie–Hellman public key on the P-256 curve associated with the push subscription
keyAuth	string or null An authentication secret associated with the push subscription

{"endpoint": "string",
"keyP256dh": "string",
"keyAuth": "string"
}

Sms Creation Model

recipientID required	string [ 1 .. 50 ] characters ID of the notification recipient
notificationID required	integer <int32> ID of the notification
email required	string <email> non-empty Recipient e-mail
phoneNumber required	string [ 1 .. 50 ] characters Recipient phone number
subject required	string [ 1 .. 255 ] characters Notification subject
message required	string non-empty Notification message

{"recipientID": "string",
"notificationID": 0,
"email": "user@example.com",
"phoneNumber": "string",
"subject": "string",
"message": "string"
}

Template Model

id	integer <int32> Unique ID of the template
name	string Name of template
description	string or null Description of template to indicates the purpose of the template
type	string Enum: "MASTER" "COMPONENT" Type of the template
subject	string or null The template subject (e-mail/notification subject)
value	string The template itself (e-mail body) in HTML
language	string or null 2 letters ISO 639-1 language of the template
serviceId	integer or null <int32> The identifier of the iGovPortal service to which the template is associated
senderId	string or null The identifier of the sender (canton, town, ...) to wich the template is associated
isEnabled	boolean Indicates if the template can be used (active)
score	integer or null <int32> Score of the template
createdBy	string Author of the template
createStamp	string <date-time> Stamp of creation of the template
updatedBy	string or null Author of the last update of the template
updateStamp	string or null <date-time> Stamp of the last update of the template

{"id": 0,
"name": "string",
"description": "string",
"type": "MASTER",
"subject": "string",
"value": "string",
"language": "string",
"serviceId": 0,
"senderId": "string",
"isEnabled": true,
"score": 0,
"createdBy": "string",
"createStamp": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"updateStamp": "2019-08-24T14:15:22Z"
}

Template Creation Model

name required	string non-empty Name of template
description	string or null <= 255 characters Description of template to indicates the purpose of the template
type required	string Enum: "MASTER" "COMPONENT" Type of the template
subject	string or null The tempalte subject (e-mail/notification subject)
value required	string non-empty The template itself (e-mail body) in HTML
language	string or null <= 2 characters 2 letters ISO 639-1 language of the template
serviceId	integer or null <int32> The identifier of the iGovPortal service to which the template is associated
senderId	string or null <= 50 characters The identifier of the sender (canton, town, ...) to wich the template is associated
isEnabled	boolean Default: true Indicates if the template can be used (active)
createdBy required	string [ 1 .. 100 ] characters Author of the template

{"name": "string",
"description": "string",
"type": "MASTER",
"subject": "string",
"value": "string",
"language": "st",
"serviceId": 0,
"senderId": "string",
"isEnabled": true,
"createdBy": "string"
}

Template Restore Previous Version Model

updatedBy

required

string [ 1 .. 100 ] characters

Author of the restoration

{"updatedBy": "string"
}

Template Update Model

name required	string non-empty Name of template
description	string or null <= 255 characters Description of template to indicates the purpose of the template
type required	string Enum: "MASTER" "COMPONENT" Type of the template. The type can be MASTER or COMPONENT
subject	string or null The tempalte subject (e-mail/notification subject)
value required	string non-empty The template itself (e-mail body) in HTML
language	string or null <= 2 characters 2 letters ISO 639-1 language of the template
serviceId	integer or null <int32> The identifier of the iGovPortal service to which the template is associated
senderId	string or null <= 50 characters The identifier of the sender (canton, town, ...) to wich the template is associated
isEnabled required	boolean Indicates if the template can be used (active)
updatedBy required	string [ 1 .. 100 ] characters Author of the last update of the template

{"name": "string",
"description": "string",
"type": "MASTER",
"subject": "string",
"value": "string",
"language": "st",
"serviceId": 0,
"senderId": "string",
"isEnabled": true,
"updatedBy": "string"
}

Template Rendering Model

language	string E-mail language
serviceId	integer or null <int32> Service identifier to which the e-mail is attached
senderId	string or null Sender (town, departement, ...) identifier to which the e-mail is attached
	object or null Data that can be injected into e-mail templates

{"language": "string",
"serviceId": 0,
"senderId": "string",
"templateData": {"serviceName": "string",
"serviceLink": {"linkUrl": "string",
"iconUrl": "string"
},
"recipient": {"gender": "Unknown",
"firstname": "string",
"lastname": "string",
"organizationName": "string"
},
"subject": "string",
"body": "string",
"uiPortalTemplateName": "string",
"businessCase": {"status": "string",
"processingTimeInHours": 0,
"lastUpdateStamp": "2019-08-24T14:15:22Z",
"actionUrl": "string",
"actionMessage": "string",
"actionButtonText": "string"
},
"shoppingCart": {"totalPrice": 0.1,
"items": [{"name": "string",
"quantity": 0,
"price": 0.1
}
]
},
"serviceSteps": {"previousSteps": [{"name": "string",
"description": "string",
"processingTimeInHours": 0,
"iconUrl": "string",
"actionUrl": "string",
"createStamp": "2019-08-24T14:15:22Z",
"updateStamp": "2019-08-24T14:15:22Z",
"sortOrder": 0
}
],
"currentSteps": [{"name": "string",
"description": "string",
"processingTimeInHours": 0,
"iconUrl": "string",
"actionUrl": "string",
"createStamp": "2019-08-24T14:15:22Z",
"updateStamp": "2019-08-24T14:15:22Z",
"sortOrder": 0
}
],
"nextSteps": [{"name": "string",
"description": "string",
"processingTimeInHours": 0,
"iconUrl": "string",
"actionUrl": "string",
"createStamp": "2019-08-24T14:15:22Z",
"updateStamp": "2019-08-24T14:15:22Z",
"sortOrder": 0
}
]
},
"documentLinks": [{"name": "string",
"url": "string"
}
],
"messageLink": "string",
"metaData": {"property1": "string",
"property2": "string"
}
}
}

Template Rendered Model

language	string E-mail language
serviceId	integer or null <int32> Service identifier to which the e-mail is attached
senderId	string or null Sender (town, departement, ...) identifier to which the e-mail is attached
subject	string or null Rendered e-mail/notification subject
renderedEmail	string Rendered e-mail

{"language": "string",
"serviceId": 0,
"senderId": "string",
"subject": "string",
"renderedEmail": "string"
}

Channel Model

id	integer <int32> Identifier of the channel
name	string Unique name of the channel
description	string Short description of the channel
isEnabled	boolean Indicates if the channel is available globally
createdBy	string Author of the channel
createStamp	string <date-time> Stamp of creation of the channel
updatedBy	string or null Author of the last update of the channel
updateStamp	string or null <date-time> Stamp of the last update of the channel

{"id": 0,
"name": "string",
"description": "string",
"isEnabled": true,
"createdBy": "string",
"createStamp": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"updateStamp": "2019-08-24T14:15:22Z"
}

Channel Creation Model

name required	string [ 1 .. 100 ] characters Unique name of the channel
description required	string [ 1 .. 255 ] characters Short description of the channel
isEnabled	boolean Default: true Indicates if the channel is available globally
createdBy required	string [ 1 .. 100 ] characters Author of the channel

{"name": "string",
"description": "string",
"isEnabled": true,
"createdBy": "string"
}

Channel Update Model

name required	string [ 1 .. 100 ] characters Unique name of the channel
description required	string [ 1 .. 255 ] characters Short description of the channel
isEnabled	boolean Default: true Indicates if the channel is available globally
updatedBy required	string [ 1 .. 100 ] characters Author of the last update of the template

{"name": "string",
"description": "string",
"isEnabled": true,
"updatedBy": "string"
}

Channel by profile Model

id	integer <int32> Identifier of the channel
name	string Unique name of the channel
description	string Short description of the channel
isEnabled	boolean Indicates if the channel is available globally
createdBy	string Author of the channel
createStamp	string <date-time> Stamp of creation of the channel
updatedBy	string or null Author of the last update of the channel
updateStamp	string or null <date-time> Stamp of the last update of the channel
	object Relation giving access to the channel within the profile

{"id": 0,
"name": "string",
"description": "string",
"isEnabled": true,
"createdBy": "string",
"createStamp": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"updateStamp": "2019-08-24T14:15:22Z",
"profileChannel": {"id": 0,
"profileId": 0,
"channelId": 0,
"isEnabled": true,
"createdBy": "string",
"createStamp": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"updateStamp": "2019-08-24T14:15:22Z"
}
}

Profile Channel Model

id	integer <int32> Identifier of the profile channel
profileId	integer <int32> Profile identifier
channelId	integer <int32> Channel identifier. Reference on Notifications.Api.Entities.Models.Channel table
isEnabled	boolean Indicates if the channel is available globally
createdBy	string Author of the profile channel
createStamp	string <date-time> Stamp of creation of the profile channel
updatedBy	string or null Author of the last update of the profile channel
updateStamp	string or null <date-time> Stamp of the last update of the profile channel

{"id": 0,
"profileId": 0,
"channelId": 0,
"isEnabled": true,
"createdBy": "string",
"createStamp": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"updateStamp": "2019-08-24T14:15:22Z"
}

Profile Channel Upsert Model

isEnabled	boolean Default: true Indicates if the channel is available globally
createdBy required	string [ 1 .. 100 ] characters Author of the channel

{"isEnabled": true,
"createdBy": "string"
}

Muted Service Model

id	integer <int32> Identifier of the muted service
profileChannelId	integer <int32> ProfileChannel identifier. Reference on Notifications.Api.Entities.Models.ProfileChannel table
serviceId	integer <int32> Service identifier
channelId	integer <int32> Channel identifier. Reference on Notifications.Api.Entities.Models.Channel table
channelName	string Channel name identifier. Reference on Notifications.Api.Entities.Models.Channel table
createdBy	string Author of the muted service
createStamp	string <date-time> Stamp of creation of the muted service
updatedBy	string or null Author of the last update of the muted service
updateStamp	string or null <date-time> Stamp of the last update of the muted service

{"id": 0,
"profileChannelId": 0,
"serviceId": 0,
"channelId": 0,
"channelName": "string",
"createdBy": "string",
"createStamp": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"updateStamp": "2019-08-24T14:15:22Z"
}

Muted Service Upsert Model

createdBy

required

string [ 1 .. 100 ] characters

Author of the muted service

{"createdBy": "string"
}

Push Subscription Model

id	integer <int32> Identifier of the push subscription
profileId	integer <int32> Profile identifier
description	string Short description of the push subscription
endpoint	string or null Endpoint associated with the push subscription
keyP256dh	string or null An Elliptic curve Diffie–Hellman public key on the P-256 curve associated with the push subscription
keyAuth	string or null An authentication secret associated with the push subscription
createdBy	string Author of the push subscription
createStamp	string <date-time> Stamp of creation of the push subscription
updatedBy	string or null Author of the last update of the push subscription
updateStamp	string or null <date-time> Stamp of the last update of the push subscription

{"id": 0,
"profileId": 0,
"description": "string",
"endpoint": "string",
"keyP256dh": "string",
"keyAuth": "string",
"createdBy": "string",
"createStamp": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"updateStamp": "2019-08-24T14:15:22Z"
}

Push Subscription Creation Model

description required	string [ 1 .. 100 ] characters Short description of the push subscription
endpoint	string or null <= 1800 characters Endpoint associated with the push subscription
keyP256dh	string or null <= 200 characters An Elliptic curve Diffie–Hellman public key on the P-256 curve associated with the push subscription
keyAuth	string or null <= 50 characters An authentication secret associated with the push subscription
createdBy required	string [ 1 .. 100 ] characters Author of the push subscription

{"description": "string",
"endpoint": "string",
"keyP256dh": "string",
"keyAuth": "string",
"createdBy": "string"
}

Push Subscription Update Model

description	string or null <= 100 characters Short description of the push subscription
endpoint	string or null <= 1800 characters Endpoint associated with the push subscription
keyP256dh	string or null <= 200 characters An Elliptic curve Diffie–Hellman public key on the P-256 curve associated with the push subscription
keyAuth	string or null <= 50 characters An authentication secret associated with the push subscription
updatedBy required	string [ 1 .. 100 ] characters Author of the last update of the push subscription

{"description": "string",
"endpoint": "string",
"keyP256dh": "string",
"keyAuth": "string",
"updatedBy": "string"
}

Error Model

type	string or null URI that identifies the problem detail type
title	string or null A short human-readable summary about the problem
status	integer or null <int32> HTTP Status Code
detail	string or null A human-readable explanation about the problem
traceId	string <uuid> Guid to trace the error in the log files
property name* additional property	any

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"traceId": "729bb1bf-882d-483b-89d3-5855dc5af3aa",
"property1": null,
"property2": null
}