Insurance Council Australia Wp V2 Categories

InsuranceAustraliaGeneral InsuranceIndustry AssociationProperty and CasualtyClaimsCatastropheRisk DataCode of Practice
View JSON Schema on GitHub

JSON Schema

insurance-council-australia-wp-v2-categories.json Raw ↑
{
    "namespace": "wp/v2",
    "methods": [
        "GET",
        "POST"
    ],
    "endpoints": [
        {
            "methods": [
                "GET"
            ],
            "allow_batch": {
                "v1": true
            },
            "args": {
                "context": {
                    "description": "Scope under which the request is made; determines fields present in response.",
                    "type": "string",
                    "enum": [
                        "view",
                        "embed",
                        "edit"
                    ],
                    "default": "view",
                    "required": false
                },
                "page": {
                    "description": "Current page of the collection.",
                    "type": "integer",
                    "default": 1,
                    "minimum": 1,
                    "required": false
                },
                "per_page": {
                    "description": "Maximum number of items to be returned in result set.",
                    "type": "integer",
                    "default": 10,
                    "minimum": 1,
                    "maximum": 100,
                    "required": false
                },
                "search": {
                    "description": "Limit results to those matching a string.",
                    "type": "string",
                    "required": false
                },
                "exclude": {
                    "description": "Ensure result set excludes specific IDs.",
                    "type": "array",
                    "items": {
                        "type": "integer"
                    },
                    "default": [],
                    "required": false
                },
                "include": {
                    "description": "Limit result set to specific IDs.",
                    "type": "array",
                    "items": {
                        "type": "integer"
                    },
                    "default": [],
                    "required": false
                },
                "order": {
                    "description": "Order sort attribute ascending or descending.",
                    "type": "string",
                    "default": "asc",
                    "enum": [
                        "asc",
                        "desc"
                    ],
                    "required": false
                },
                "orderby": {
                    "description": "Sort collection by term attribute.",
                    "type": "string",
                    "default": "name",
                    "enum": [
                        "id",
                        "include",
                        "name",
                        "slug",
                        "include_slugs",
                        "term_group",
                        "description",
                        "count"
                    ],
                    "required": false
                },
                "hide_empty": {
                    "description": "Whether to hide terms not assigned to any posts.",
                    "type": "boolean",
                    "default": false,
                    "required": false
                },
                "parent": {
                    "description": "Limit result set to terms assigned to a specific parent.",
                    "type": "integer",
                    "required": false
                },
                "post": {
                    "description": "Limit result set to terms assigned to a specific post.",
                    "type": "integer",
                    "default": null,
                    "required": false
                },
                "slug": {
                    "description": "Limit result set to terms with one or more specific slugs.",
                    "type": "array",
                    "items": {
                        "type": "string"
                    },
                    "required": false
                }
            }
        },
        {
            "methods": [
                "POST"
            ],
            "allow_batch": {
                "v1": true
            },
            "args": {
                "description": {
                    "description": "HTML description of the term.",
                    "type": "string",
                    "required": false
                },
                "name": {
                    "description": "HTML title for the term.",
                    "type": "string",
                    "required": true
                },
                "slug": {
                    "description": "An alphanumeric identifier for the term unique to its type.",
                    "type": "string",
                    "required": false
                },
                "parent": {
                    "description": "The parent term ID.",
                    "type": "integer",
                    "required": false
                },
                "meta": {
                    "description": "Meta fields.",
                    "type": "object",
                    "properties": [],
                    "required": false
                },
                "acf": {
                    "description": "ACF field data",
                    "type": "object",
                    "properties": [],
                    "required": false
                }
            }
        }
    ],
    "schema": {
        "$schema": "http://json-schema.org/draft-04/schema#",
        "title": "category",
        "type": "object",
        "properties": {
            "id": {
                "description": "Unique identifier for the term.",
                "type": "integer",
                "context": [
                    "view",
                    "embed",
                    "edit"
                ],
                "readonly": true
            },
            "count": {
                "description": "Number of published posts for the term.",
                "type": "integer",
                "context": [
                    "view",
                    "edit"
                ],
                "readonly": true
            },
            "description": {
                "description": "HTML description of the term.",
                "type": "string",
                "context": [
                    "view",
                    "edit"
                ]
            },
            "link": {
                "description": "URL of the term.",
                "type": "string",
                "format": "uri",
                "context": [
                    "view",
                    "embed",
                    "edit"
                ],
                "readonly": true
            },
            "name": {
                "description": "HTML title for the term.",
                "type": "string",
                "context": [
                    "view",
                    "embed",
                    "edit"
                ],
                "required": true
            },
            "slug": {
                "description": "An alphanumeric identifier for the term unique to its type.",
                "type": "string",
                "context": [
                    "view",
                    "embed",
                    "edit"
                ]
            },
            "taxonomy": {
                "description": "Type attribution for the term.",
                "type": "string",
                "enum": [
                    "category"
                ],
                "context": [
                    "view",
                    "embed",
                    "edit"
                ],
                "readonly": true
            },
            "parent": {
                "description": "The parent term ID.",
                "type": "integer",
                "context": [
                    "view",
                    "edit"
                ]
            },
            "meta": {
                "description": "Meta fields.",
                "type": "object",
                "context": [
                    "view",
                    "edit"
                ],
                "properties": []
            },
            "acf": {
                "description": "ACF field data",
                "type": "object",
                "properties": []
            }
        }
    },
    "_links": {
        "self": [
            {
                "href": "https://insurancecouncil.com.au/wp-json/wp/v2/categories"
            }
        ]
    }
}