Page

Contain data reffered to pages.


Receive a list of all Pages

Query parameters:
  • fields - list of fields returning in response
  • limit - number of returned pages (default: 50)
  • page - currently displayed page (default: 1)
  • since_id - restrict pages to greater identifiers than specified id
  • url - filter with url
  • visibility - filter with visibility
  • created_at_min - shows pages, which creation date was later than specified (format: 2011-06-19 13:18:50)
  • created_at_max - shows pages, which creation date was earlier than specified (format: 2011-06-19 13:18:50)
  • updated_at_min - shows pages, which modification date was later than specified (format: 2011-06-19 13:18:50)
  • updated_at_max - shows pages, which modification date was earlier than specified (format: 2011-06-19 13:18:50)
GET /services/pages

Returns all pages

HTTP/1.1 200 OK
    {
        "pages": [
            {
                "id" : 1,
                "title" : "O nas",
                "handle" : "o_nas",
                "url" : "o-nas",
                "content" : "Oto strona, na ktorej mozesz umiescic wszystkie wazne informacje o Twoim sklepie",
                "visibility" : 1,
                "created_at" : "2011-09-22 01:15:35",
                "updated_at" : "2011-09-22 01:15:35",
                "metadata" : [
                {
                    "meta_title" : "O nas",
                    "meta_description" : "Strona o firmie",
                    "meta_keywords" : "o nas, informacje, mapa dojazdu",
                },
                ],
            },
            {
                "id" : 2,
                "title" : "Polityka Prywatnosci",
                "handle" : "polityka_prywatnosci",
                "url" : "polityka-prywatnosci",
                "content" : "Oto strona, na ktorej mozesz umiescic polityke prywatnosci",
                "visibility" : 1,
                "created_at" : "2011-09-22 01:15:35",
                "updated_at" : "2011-09-22 01:15:35",
                "metadata" : [
                {
                    "meta_title" : "Polityka prywatnosci",
                    "meta_description" : "Polityka prywatnosci",
                    "meta_keywords" : "polityka prywatnosci, polityka cookies",
                },
                ],
            },
        ]
    }

Receive a count of all Pages

Query parameters:
  • fields - list of fields returning in response
  • since_id - restrict pages to greater identifiers than specified id
  • url - filter with url
  • visibility - filter with visibility
  • created_at_min - count pages, which creation date was later than specified (format: 2011-06-19 13:18:50)
  • created_at_max - count pages, which creation date was earlier than specified (format: 2011-06-19 13:18:50)
  • updated_at_min - count pages, which modification date was later than specified (format: 2011-06-19 13:18:50)
  • updated_at_max - count pages, which modification date was earlier than specified (format: 2011-06-19 13:18:50)
GET /services/pages/count

Receive a count of all Pages

HTTP/1.1 200 OK
{
    "count": 2
}

Receive a single Page

Query parameters:
  • fields - list of fields returning in response
GET services/pages/{id}

Receive a single Page

Response
HTTP/1.1 200 OK
{
    "id" : 1,
    "title" : "O nas",
    "handle" : "o_nas",
    "url" : "o-nas",
    "content" : "Oto strona, na ktorej mozesz umiescic wszystkie wazne informacje o Twoim sklepie",
    "visibility" : 1,
    "created_at" : "2011-09-22 01:15:35",
    "updated_at" : "2011-09-22 01:15:35",
    "metadata" : [
    {
        "meta_title" : "O nas",
        "meta_description" : "Strona o firmie",
        "meta_keywords" : "o nas, informacje, mapa dojazdu",
    },
    ],
}

Create a Page

POST services/pages

Create page with specified parameters

Request
{
"page": {
    "title" : "O nas",
    "url" : "o-nas",
    "content" : "Oto strona, na ktorej mozesz umiescic wszystkie wazne informacje o Twoim sklepie",
    "visibility" : 1,
    "metadata" : [
    {
        "meta_title" : "O nas",
        "meta_description" : "Strona o firmie",
        "meta_keywords" : "o nas, informacje, mapa dojazdu",
    },
    ],
}
Response
HTTP/1.1 200 OK
{
    "page": {
        "id" : 1,
        "title" : "O nas",
        "handle" : "o_nas",
        "url" : "o-nas",
        "content" : "Oto strona, na ktorej mozesz umiescic wszystkie wazne informacje o Twoim sklepie",
        "visibility" : 1,
        "created_at" : "2011-09-22 01:15:35",
        "updated_at" : "2011-09-22 01:15:35",
        "metadata" : [
        {
            "meta_title" : "O nas",
            "meta_description" : "Strona o firmie",
            "meta_keywords" : "o nas, informacje, mapa dojazdu",
        },
        ],
    }
}

Update an existing Page

PUT services/pages/{id}

You can update a given page

Request
{
    "page": {
        "title"	: "Informacje o firmie",
        "description"	: "Nowa tresc strony o nas",
        "metadata" : [
        {
            "meta_title" : "",
            "meta_description" : "",
            "meta_keywords" : "",
        },
        ],
    },
}
Response
HTTP/1.1 200 OK
{
    "id"	: 1,
}

Delete an existing Page

DELETE services/pages/{id}

Delete an existing page from a shop

Response
HTTP/1.1 200 OK
{
    "status"	: "ok",
}