Resource Representation

Example:
{
  "npc_entity_id": 257,
  "category_id": 16,
  "is_primary": false
}

Supported Formats

json

GET /api/v2/npc_entity_categories DEPRECATED
List npc entity category links.

Supported Formats

json

Errors

Code Description
401 Unauthorized. Include a WWW-Authenticate header field containing a challenge applicable to the requested resource.
403 Forbidden. The request was a valid request, but the server is refusing to respond to it. 403 error semantically means "unauthorized", i.e. the user does not have the necessary permissions for the resource.
404 Not Found. The requested resource could not be found.
422 Unprocessable Entity. The request was well-formed but was unable to be followed due to semantic errors.
500 Internal Server Error. An unexpected condition was encountered.

Examples

Response:
  {
    "page": 1,
    "per_page": 50,
    "total_pages": 1,
    "total_entries": 1,
    "entries": [
      {
        "id": 6,
        "npc_entity_id": 257,
        "category_id": 16
        "is_primary": false
      }
      }
    ]
  }

Params

Param name Description
per_page
optional

Number of objects in one response. Default is 50

Validations:

  • Must be a number.

page
optional

Page number. Default is 1

Validations:

  • Must be a number.

created_time_from
optional

ISO_8601 format 2016-05-30T05:13:26Z

Validations:

  • Must be a String

created_time_to
optional

ISO_8601 format 2016-05-30T05:13:26Z

Validations:

  • Must be a String

updated_time_from
optional

ISO_8601 format 2016-05-30T05:13:26Z

Validations:

  • Must be a String

updated_time_to
optional

ISO_8601 format 2016-05-30T05:13:26Z

Validations:

  • Must be a String


POST /api/v2/npc_entity_categories DEPRECATED
Create a npc entity category.

Supported Formats

json

Errors

Code Description
401 Unauthorized. Include a WWW-Authenticate header field containing a challenge applicable to the requested resource.
403 Forbidden. The request was a valid request, but the server is refusing to respond to it. 403 error semantically means "unauthorized", i.e. the user does not have the necessary permissions for the resource.
404 Not Found. The requested resource could not be found.
422 Unprocessable Entity. The request was well-formed but was unable to be followed due to semantic errors.
500 Internal Server Error. An unexpected condition was encountered.

Examples

request:
  {
    "npc_entity_category": {
      "npc_entity_id": 257,
      "category_id": 16
    }
  }

response:
  {
    "id": 6,
    "npc_entity_id": 257,
    "category_id": 16
    "is_primary": false
  }

Params

Param name Description
npc_entity_category
required

Validations:

  • Must be a Hash

npc_entity_category[npc_entity_id]
required

Npc entity ID

Validations:

  • Must be a Integer

npc_entity_category[category_id]
required

Category ID

Validations:

  • Must be a Integer

npc_entity_category[is_primary]
optional , nil allowed

Specify this to be primary category of the Npc entity

Validations:

  • Must be one of: true, false, 1, 0.


DELETE /api/v2/npc_entity_categories/:id DEPRECATED
Delete a npc entity category.

Supported Formats

json

Errors

Code Description
401 Unauthorized. Include a WWW-Authenticate header field containing a challenge applicable to the requested resource.
403 Forbidden. The request was a valid request, but the server is refusing to respond to it. 403 error semantically means "unauthorized", i.e. the user does not have the necessary permissions for the resource.
404 Not Found. The requested resource could not be found.
422 Unprocessable Entity. The request was well-formed but was unable to be followed due to semantic errors.
500 Internal Server Error. An unexpected condition was encountered.

Examples

response:
  {
    "id": 6
  }