Fetch Event Templates

Fetch All Event Templates

This endpoint allows you to retrieve all the Arianee event templates created on your NFT Management Platform.

URL

Required rights: admin or certRead

To update an event template, use the /arianeeEventTemplate.

GET - https://{{nmpUrl}}/arianeeEventTemplate

Return Payload

Status Code	Success	Description
`200`	`true`	All the event templates are returned.

[
    {
        "_id": "679cc0abd8e520b102433c1d",
        "deleted": false,
        "metadata": {
            "name": "Evenement de Service",
            "icon": "https://img.freepik.com/vecteurs-premium/vecteur-conception-modele-logo-service_20029-568.jpg"
        },
        "content": "{\"eventType\":\"repair\",\"language\":\"fr-FR\",\"title\":\"Réparation effectuée\",\"description\":\"Votre produit a été réparé avec succès et est désormais opérationnel.\",\"i18n\":[],\"$schema\":\"https://cert.arianee.org/version1/ArianeeEvent-i18n.json\"}",
        "attributes": [],
        "__v": 0,
        "id": "679cc0abd8e520b102433c1d"
    },
    {
        "_id": "679cc0c7d8e520b102433c29",
        "deleted": false,
        "metadata": {
            "name": "Activation de la garantie",
            "icon": "https://img.freepik.com/vecteurs-premium/vecteur-conception-modele-logo-service_20029-568.jpg"
        },
        "content": "{\"eventType\":\"warranty\",\"language\":\"fr-FR\",\"title\":\"Activation de la garantie\",\"description\":\"La garantie de votre produit a été activée ou mise à jour avec succès. Pour une durée de %duration%.\",\"i18n\":[],\"$schema\":\"https://cert.arianee.org/version1/ArianeeEvent-i18n.json\"}",
        "attributes": [
            {
                "field": "%duration%",
                "label": "Durée",
                "freeEntry": true,
                "required": true,
                "type": "select",
                "options": [
                    {
                        "label": "1 an",
                        "value": "1 an"
                    },
                    {
                        "label": "2 ans",
                        "value": "2 ans"
                    },
                    {
                        "label": "4 ans",
                        "value": "4 ans"
                    }
                ]
            }
        ],
        "__v": 0,
        "id": "679cc0c7d8e520b102433c29"
    }
]

Fetch Specific Event Template

This endpoint allows you to fetch a target existing Arianee event template.

URL

Required rights: admin or certRead

To update an event template, use the /arianeeEventTemplate/:id.

GET - https://{{nmpUrl}}/arianeeEventTemplate/:id

Return Payload

Status Code	Success	Description
`200`	`true`	The event template has been created.

{
    "_id": "67a08e452ef96f911a194989",
    "deleted": false,
    "metadata": {
        "name": "Activation de la garantie",
        "icon": "https://img.freepik.com/vecteurs-premium/vecteur-conception-modele-logo-service_20029-568.jpg"
    },
    "content": "{\"eventType\":\"warranty\",\"language\":\"fr-FR\",\"title\":\"Activation de la garantie\",\"description\":\"La garantie de votre produit a été activée ou mise à jour avec succès. Pour une durée de %duree%.\",\"i18n\":[],\"$schema\":\"https://cert.arianee.org/version3/ArianeeEvent-i18n.json\"}",
    "attributes": [
        {
            "field": "%duree%",
            "label": "Durée",
            "freeEntry": true,
            "required": true,
            "type": "select",
            "options": [
                {
                    "label": "1 an",
                    "value": "1 an"
                },
                {
                    "label": "2 ans",
                    "value": "2 ans"
                },
                {
                    "label": "4 ans",
                    "value": "4 ans"
                }
            ]
        }
    ],
    "__v": 0,
    "id": "67a08e452ef96f911a194989"
}

Errors

Status Code	Success	Error Message
`500`	`false`	The event template ID may be wrong.

{
    "stringValue": "\"67a08e452ef96f911a19498\"",
    "valueType": "string",
    "kind": "ObjectId",
    "value": "67a08e452ef96f911a19498",
    "path": "_id",
    "reason": {},
    "name": "CastError",
    "message": "Cast to ObjectId failed for value \"67a08e452ef96f911a19498\" (type string) at path \"_id\" for model \"ArianeeEventTemplate\""
}

Updated 4 months ago