Month Wallpapers

The Month Wallpapers API provides access to monthly wallpapers within the Sumaya369 platform. This API enables users to view all available wallpapers and retrieve the currently active wallpaper.

List Month Wallpapers

Retrieve a list of all displayed wallpapers, grouped by year.

Endpoint

• Method: GET
• URL: /v1/customer/month-wallpapers

Request Headers

Header	Value	Required
Content-Type	application/json	Yes
Accept	application/json	Yes

Success Response

{
    "success": true,
    "message": "تم جلب البيانات بنجاح.",
    "data": {
        "2024": [
            {
                "id": "8290fac0-0797-11ef-8bb0-6b1e469387bb",
                "date": "2024-05-01",
                "displayed": true,
                "selected": true,
                "media": [
                    {
                        "id": 12345,
                        "file_name": "wallpaper-may-2024.jpg",
                        "collection_name": "wallpapers",
                        "disk": "s3"
                    }
                ],
                "created_at": "2024-05-01 11:47:58"
            },
            {
                "id": "762b3320-f2c3-11ee-a07e-3358d74636f7",
                "date": "2024-04-02",
                "displayed": true,
                "selected": false,
                "media": [
                    {
                        "id": 12344,
                        "file_name": "wallpaper-april-2024.jpg",
                        "collection_name": "wallpapers",
                        "disk": "s3"
                    }
                ],
                "created_at": "2024-04-04 23:39:41"
            }
        ]
    },
    "status_code": 200
}

Get First Active Wallpaper

Retrieve the currently selected (active) month wallpaper.

Endpoint

• Method: GET
• URL: /v1/customer/month-wallpapers/wallpaper

Request Headers

Header	Value	Required
Accept	application/json	Yes

Success Response

{
    "success": true,
    "message": "تم جلب البيانات بنجاح.",
    "data": {
        "id": "8290fac0-0797-11ef-8bb0-6b1e469387bb",
        "date": "2024-05-01",
        "displayed": true,
        "selected": true,
        "media": [
            {
                "id": 12345,
                "file_name": "wallpaper-may-2024.jpg",
                "collection_name": "wallpapers",
                "disk": "s3"
            }
        ],
        "created_at": "2024-05-01 11:47:58"
    },
    "status_code": 200
}

Error Response

Wallpaper Not Found (404)

{
    "success": false,
    "message": "لم يتم العثور على السجل",
    "data": [],
    "status_code": 404
}

Implementation Flow

1. List Month Wallpapers

   • Application sends request to /v1/customer/month-wallpapers
   • Wallpapers are retrieved and grouped by year
   • Only displayed wallpapers are included in the response

2. First Active Wallpaper

   • Application sends request to /v1/customer/month-wallpapers/first-active
   • Returns the currently selected wallpaper
   • Returns 404 if no wallpaper is selected (web platform)
   • Returns null if no wallpaper is selected (mobile platform)

Key Considerations

• Wallpapers can be marked as displayed/hidden
• Only one wallpaper can be marked as selected at a time
• Platform-specific behavior for missing active wallpapers
• Media files are stored using the media library system
• Response includes media information for proper file handling