NotificationsApiInterface.md

OpenAPI\Server\Api\NotificationsApiInterface

All URIs are relative to https://share.catrob.at/api

Method	HTTP request	Description
notificationIdReadPut	PUT /notification/{id}/read	Mark specified notification as read - StatusCode: 501 - Not yet implemented
notificationsCountGet	GET /notifications/count	Count the number of unseen notifications -- StatusCode: 501 - Not yet implemented
notificationsGet	GET /notifications	Get user notifications -- StatusCode: 501 - Not yet implemented
notificationsReadPut	PUT /notifications/read	Mark all notifications as read -- StatusCode: 501 - Not yet implemented

Service Declaration

# src/Acme/MyBundle/Resources/services.yml
services:
    # ...
    acme.my_bundle.api.notifications:
        class: Acme\MyBundle\Api\NotificationsApi
        tags:
            - { name: "open_api_server.api", api: "notifications" }
    # ...

notificationIdReadPut

notificationIdReadPut($id, $accept_language)

Mark specified notification as read - StatusCode: 501 - Not yet implemented

Example Implementation

<?php
// src/Acme/MyBundle/Api/NotificationsApiInterface.php

namespace Acme\MyBundle\Api;

use OpenAPI\Server\Api\NotificationsApiInterface;

class NotificationsApi implements NotificationsApiInterface
{

    // ...

    /**
     * Implementation of NotificationsApiInterface#notificationIdReadPut
     */
    public function notificationIdReadPut(int $id, string $accept_language = null)
    {
        // Implement the operation ...
    }

    // ...
}

Parameters

Name	Type	Description	Notes
id	int		[default to 0]
accept_language	string		[optional]

Return type

void (empty response body)

Authorization

PandaAuth

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

notificationsCountGet

OpenAPI\Server\Model\NotificationsCountResponse notificationsCountGet()

Count the number of unseen notifications -- StatusCode: 501 - Not yet implemented

Example Implementation

<?php
// src/Acme/MyBundle/Api/NotificationsApiInterface.php

namespace Acme\MyBundle\Api;

use OpenAPI\Server\Api\NotificationsApiInterface;

class NotificationsApi implements NotificationsApiInterface
{

    // ...

    /**
     * Implementation of NotificationsApiInterface#notificationsCountGet
     */
    public function notificationsCountGet()
    {
        // Implement the operation ...
    }

    // ...
}

Parameters

This endpoint does not need any parameter.

Return type

OpenAPI\Server\Model\NotificationsCountResponse

Authorization

PandaAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

notificationsGet

OpenAPI\Server\Model\NotificationResponse notificationsGet($accept_language, $limit, $offset, $type)

Get user notifications -- StatusCode: 501 - Not yet implemented

Example Implementation

<?php
// src/Acme/MyBundle/Api/NotificationsApiInterface.php

namespace Acme\MyBundle\Api;

use OpenAPI\Server\Api\NotificationsApiInterface;

class NotificationsApi implements NotificationsApiInterface
{

    // ...

    /**
     * Implementation of NotificationsApiInterface#notificationsGet
     */
    public function notificationsGet(string $accept_language = null, int $limit = '20', int $offset = '0', NotificationsType $type = null)
    {
        // Implement the operation ...
    }

    // ...
}

Parameters

Name	Type	Description	Notes
accept_language	string		[optional]
limit	int		[optional] [default to 20]
offset	int		[optional] [default to 0]
type	OpenAPI\Server\Model\NotificationsType		[optional]

Return type

OpenAPI\Server\Model\NotificationResponse

Authorization

PandaAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

notificationsReadPut

notificationsReadPut()

Mark all notifications as read -- StatusCode: 501 - Not yet implemented

Example Implementation

<?php
// src/Acme/MyBundle/Api/NotificationsApiInterface.php

namespace Acme\MyBundle\Api;

use OpenAPI\Server\Api\NotificationsApiInterface;

class NotificationsApi implements NotificationsApiInterface
{

    // ...

    /**
     * Implementation of NotificationsApiInterface#notificationsReadPut
     */
    public function notificationsReadPut()
    {
        // Implement the operation ...
    }

    // ...
}

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

PandaAuth

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]