Page Type

Provides Page Types which are applied to a Page

Resource URIs

Item URI: /api/0.1/page_type/{pk}/

Collection URI: /api/0.1/page_type/

Item

Item Methods

GET Retrieve a Page Type by id

Item properties

Name Description Type HTTP Support
title The Page Type’s title, e.g. “Public Figure” text GET: required

self A link to this resource

Collection

Collection methods

GET Get a list of Page Types.

self A link to this resource

Embedded collections

page_types A collection of Page Types with properties as described under Item properties and links as described under Item links

Usage

GET Page Type entity

Request GET: /api/0.1/page_type/{pk}/
Response
{
    '_links': {
        'documentation': [
            {
                'href': 'https://developer.underarmour.com/docs/01_Page_Type/'
            }
        ],
        'self': [
            {
                'href': '/api/0.1/page_type/public_entity/',
                'id': 'public_entity'
            }
        ],
    },
    'title': 'Public entity'
}

GET Page Type collection

Request GET: /api/0.1/page_type/
Response
{
    '_embedded': {
        'page_types': [
            {
                '_links': {
                    'self': [
                        {
                            'href': '/api/0.1/page_type/personal/',
                            'id': 'personal'
                        }
                    ],
                },
                'title': 'Personal'
            },
            {
                '_links': {
                    'self': [
                        {
                            'href': '/api/0.1/page_type/public_entity/',
                            'id': 'public_entity'
                        }
                    ],
                },
                'title': 'Public entity'
            },
            {
                '_links': {
                    'self': [
                        {
                            'href': '/api/0.1/page_type/public_figure/',
                            'id': 'public_figure'
                        }
                    ],
                },
                'title': 'Public figure'
            }
        ]
    },
    '_links': {
        'documentation': [
            {
                'href': 'https://developer.underarmour.com/docs/01_Page_Type/'
            }
        ],
        'self': [
            {
                'href': '/api/0.1/page_type/?limit=20&offset=0'
            }
        ]
    },
    'total_count': 3
}