POST /api/v2/shared_reference_categories
Create a Shared reference 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:
  {
    "shared_reference_category": {
      "shared_reference_id": 257,
      "category_id": 16
    }
  }

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

Params

Param name Description
shared_reference_category
required

Validations:

  • Must be a Hash
shared_reference_category[shared_reference_id]
required

Shared reference ID

Validations:

  • Must be a Integer
shared_reference_category[category_id]
required

Category ID

Validations:

  • Must be a Integer
shared_reference_category[is_primary]
optional , nil allowed

Specify this to be primary category of the Shared reference

Validations:

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