Brands
Brands are the top level categorization of instruments. (ex: Fender)

Example JSON Representation ↑

{
  "id":549,
  "type_id": 1,
  "name":"New Brand",
  "approved":true
}

Supported Formats

json
>>>

GET /brands
List brands

Supported Formats

json

Errors

400 The request was unacceptable, often due to missing a required parameter.

Params

Param name Description
page
optional
Value:

Must be Integer.
per_page
optional
Value:

Must be Integer.
name
optional

List brands with names matching the provided string.


Value:

Must be String
name_like
optional

List brands with names matching, or similar to, the provided string. Slower, but useful for correcting user input.


Value:

Must be String
approved
optional
Value:

Must be true or false.
pending
optional
Value:

Must be true or false.
in_use
optional

Only return brands that have one or more instrument.


Value:

Must be true or false.
in_serial_lookup
optional

Only return brands that have one or more serial number ranges defined.


Value:

Must be true or false.
>>>

GET /brands/:id
Show a brand

Supported Formats

json

Errors

400 The request was unacceptable, often due to missing a required parameter.
>>>

POST /brands
Create a brand

Supported Formats

json

Errors

400 The request was unacceptable, often due to missing a required parameter.

Examples

curl -X POST -H "Authorization: XXXX" -H "Content-Type: application/json" -d '{"name": "New Brand"}' "https://api.axefax.com/brands"

Response:

{
  "brand":{
    "id":549,
    "type_id": 1,
    "name":"New Brand",
    "approved":false
  }
}

Params

Param name Description
name
required
Value:

Must be String
type_id
optional

Brand type. Only necessary if you are using the generic API (api.axefax.com)


Value:

Must be Integer.
>>>

PUT /brands/:id
Update a brand

Supported Formats

json

Errors

400

Params

Param name Description
name
required
Value:

Must be String
type_id
optional

Brand type. Only necessary if you are using the generic API (api.axefax.com)


Value:

Must be Integer.
>>>

DELETE /brands/:id
Destroy a brand

Supported Formats

json

Errors

400 The request was unacceptable, often due to missing a required parameter.
405