{"docs":{"name":"AxeFax","info":"\n

The AxeFax API allows developers with valid API tokens to query a wide range of information about instruments. To get a token for your application, contact Joe Glaser.

\n\n

The AxeFax API may be accessed from api.axefax.com, or from an instrument subdomain (guitars.axefax.com, amps.axefax.com, etc.) When using a subdomain, your API requests are automatically scoped by instrument type. For example, amps.axefax.com/brands will only return brands of amps.

\n\n

Note that if you use the top-level api.axefax.com domain, you can find, update and delete all types of instruments, and they will appear mixed together. To create brands, models, submodels or instruments from the top level domain, you need to specify a ‘?type_id=` manually, which indicates whether the item is for Guitars, Amps, etc. Valid types are listed at api.axefax.com/admin/types

\n\n

If you’re using the Admin Dashboard, you can access it from any domain and it is also scoped to the instrument type, with one caveat: you cannot create or edit instruments from the top-level admin dashboard. Because form fields depend on the type of instrument, you need to author and edit instruments from the Admin dashboard of the instrument subdomain.

\n","copyright":"© 2026 GitSuite","doc_url":"/docs/1.0","api_url":"","resources":{"brand":{"doc_url":"/docs/1.0/brand","id":"brand","api_url":"","name":"Brands","short_description":"Brands are the top level categorization of instruments. (ex: Fender)","full_description":"\n

Example JSON Representation ↑

\n\n
{\n  "id":549,\n  "type_id": 1,\n  "name":"New Brand",\n  "approved":true\n}\n
\n","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/brand/index","name":"index","apis":[{"api_url":"/brands","http_method":"GET","short_description":"List brands","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":400,"description":"The request was unacceptable, often due to missing a required parameter.","metadata":null}],"params":[{"name":"page","full_name":"page","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n

List brands with names matching the provided string.

\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name_like","full_name":"name_like","description":"\n

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

\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"approved","full_name":"approved","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be true or false.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pending","full_name":"pending","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be true or false.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"in_use","full_name":"in_use","description":"\n

Only return brands that have one or more instrument.

\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be true or false.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"in_serial_lookup","full_name":"in_serial_lookup","description":"\n

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

\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be true or false.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /brands\n200\n{\n \"pagination\": {\n \"per_page\": 25,\n \"total_pages\": 0,\n \"total_objects\": 0\n },\n \"brands\": []\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/brand/show","name":"show","apis":[{"api_url":"/brands/:id","http_method":"GET","short_description":"Show a brand","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":400,"description":"The request was unacceptable, often due to missing a required parameter.","metadata":null}],"params":[],"returns":[],"examples":["GET /brands/4291\n200\n{\n \"id\": 4291,\n \"name\": \"Breph7f0e927d-3759-4d26-bc7a-710bc9e6cf7a\",\n \"approved\": true,\n \"type\": \"Guitars\"\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/brand/create","name":"create","apis":[{"api_url":"/brands","http_method":"POST","short_description":"Create a brand","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":400,"description":"The request was unacceptable, often due to missing a required parameter.","metadata":null}],"params":[{"name":"name","full_name":"name","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type_id","full_name":"type_id","description":"\n

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

\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["\ncurl -X POST -H \"Authorization: XXXX\" -H \"Content-Type: application/json\" -d '{\"name\": \"New Brand\"}' \"https://api.axefax.com/brands\"\n\nResponse:\n\n{\n \"brand\":{\n \"id\":549,\n \"type_id\": 1,\n \"name\":\"New Brand\",\n \"approved\":false\n }\n}\n ","POST /brands\n{\n \"name\": \"Panasche09ed6ef9-4114-417f-8b97-78de243791d9\",\n \"type\": {\n \"id\": 12074,\n \"name\": \"Guitars\",\n \"subdomain\": \"guitars\"\n },\n \"brand\": {\n \"name\": \"Panasche09ed6ef9-4114-417f-8b97-78de243791d9\"\n }\n}\n201\n{\n \"id\": 4292,\n \"name\": \"Panasche09ed6ef9-4114-417f-8b97-78de243791d9\",\n \"approved\": false,\n \"type\": \"Guitars\"\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/brand/update","name":"update","apis":[{"api_url":"/brands/:id","http_method":"PUT","short_description":"Update a brand","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":400,"description":null,"metadata":null}],"params":[{"name":"name","full_name":"name","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"type_id","full_name":"type_id","description":"\n

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

\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["PATCH /brands/4294\n{\n \"name\": \"Fender\",\n \"brand\": {\n \"name\": \"Fender\"\n }\n}\n202\n{\n \"id\": 4294,\n \"name\": \"Fender\",\n \"approved\": false,\n \"type\": \"Guitars\"\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/brand/destroy","name":"destroy","apis":[{"api_url":"/brands/:id","http_method":"DELETE","short_description":"Destroy a brand","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":400,"description":"The request was unacceptable, often due to missing a required parameter.","metadata":null},{"code":405,"description":null,"metadata":null}],"params":[],"returns":[],"examples":["DELETE /brands/4299\n{\n \"brand\": {}\n}\n204"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"customers":{"doc_url":"/docs/1.0/customers","id":"customers","api_url":"","name":"Customers","short_description":"Customers are entered by appraisers and have one or more Gitfax items.","full_description":"","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/customers/index","name":"index","apis":[{"api_url":"/customers","http_method":"GET","short_description":"List customers","deprecated":null}],"formats":["json"],"full_description":"\n

Returns customers matching the criteria you provide.

\n","errors":[{"code":400,"description":"The request was unacceptable, often due to missing a required parameter.","metadata":null}],"params":[{"name":"page","full_name":"page","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/customers/show","name":"show","apis":[{"api_url":"/customers/:id","http_method":"GET","short_description":"Show a customer","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":400,"description":"The request was unacceptable, often due to missing a required parameter.","metadata":null}],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/customers/create","name":"create","apis":[{"api_url":"/items","http_method":"POST","short_description":"Create a customer","deprecated":null}],"formats":["json"],"full_description":"\n

Create the customer by passing required fields.

\n","errors":[{"code":400,"description":null,"metadata":null}],"params":[{"name":"first_name","full_name":"first_name","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"last_name","full_name":"last_name","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"email","full_name":"email","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"phone","full_name":"phone","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"address","full_name":"address","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"city","full_name":"city","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"state","full_name":"state","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"zip","full_name":"zip","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/customers/update","name":"update","apis":[{"api_url":"/customers/:id","http_method":"PUT","short_description":"Update a customer","deprecated":null}],"formats":["json"],"full_description":"\n

Modify the customer by passing new parameter values. Changes you make are permanently logged to the item’s history and update its modification date. An item’s serial number and/or RFID value cannot be changed after it is created.

\n","errors":[{"code":400,"description":null,"metadata":null}],"params":[{"name":"first_name","full_name":"first_name","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"last_name","full_name":"last_name","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"email","full_name":"email","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"phone","full_name":"phone","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"address","full_name":"address","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"city","full_name":"city","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"state","full_name":"state","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"zip","full_name":"zip","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/customers/destroy","name":"destroy","apis":[{"api_url":"/customers/:id","http_method":"DELETE","short_description":"Destroy a customer","deprecated":null}],"formats":["json"],"full_description":"\n

Note: You must be a GitFax administrator to use this API. Because GitFax stores permanent records of instrument manufacture and maintenance, deleting records is not common.

\n","errors":[{"code":400,"description":"The request was unacceptable, often due to missing a required parameter.","metadata":null}],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"items-images":{"doc_url":"/docs/1.0/items-images","id":"items-images","api_url":"","name":"GitFax Item Images","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/docs/1.0/items-images/index","name":"index","apis":[{"api_url":"/items/:id/images","http_method":"GET","short_description":"Retrieve the images for a GitFax item","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":["\ncurl -X GET -H \"Authorization: XXXXX\" \"https://api.gitfax.com/items/24/images\"\n\nResponse:\n\n{\n \"items\": [\n {\n \"id\": 1988,\n \"created_at\": \"2017-07-07T05:27:18.092Z\",\n \"thumb\": \"https://api.gitfax.com/images/files/000/001/987/thumb/C0JuVkTUAAAT9J3.jpg?1499405225\",\n \"small\": \"https://api.gitfax.com/images/files/000/001/987/small/C0JuVkTUAAAT9J3.jpg?1499405225\",\n \"medium\": \"https://api.gitfax.com/images/files/000/001/987/medium/C0JuVkTUAAAT9J3.jpg?1499405225\",\n \"large\": \"https://api.gitfax.com/images/files/000/001/987/large/C0JuVkTUAAAT9J3.jpg?1499405225\",\n \"original\": \"https://api.gitfax.com/images/files/000/001/987/original/C0JuVkTUAAAT9J3.jpg?1499405225\",\n \"role\": \"front\"\n },\n {\n \"id\": 1987,\n \"created_at\": \"2017-07-07T05:27:06.703Z\",\n \"thumb\": \"https://api.gitfax.com/images/files/000/001/987/thumb/C0JuVkTUAAAT9J3.jpg?1499405225\",\n \"small\": \"https://api.gitfax.com/images/files/000/001/987/small/C0JuVkTUAAAT9J3.jpg?1499405225\",\n \"medium\": \"https://api.gitfax.com/images/files/000/001/987/medium/C0JuVkTUAAAT9J3.jpg?1499405225\",\n \"large\": \"https://api.gitfax.com/images/files/000/001/987/large/C0JuVkTUAAAT9J3.jpg?1499405225\",\n \"original\": \"https://api.gitfax.com/images/files/000/001/987/original/C0JuVkTUAAAT9J3.jpg?1499405225\",\n \"role\": null\n }\n ]\n}\n "],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/items-images/show","name":"show","apis":[{"api_url":"/items/:id/images/:image_id","http_method":"GET","short_description":"Retrieve an individual image from a GitFax item","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":["\ncurl -X GET -H \"Authorization: XXXXX\" \"https://api.gitfax.com/items/24/images/121\"\n\n// Returns image JSON\n "],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/items-images/create","name":"create","apis":[{"api_url":"/items/:id/images","http_method":"POST","short_description":"Add a PNG or JPG image to a GitFax item","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"role","full_name":"role","description":"\n

Optional: Pass ‘front` or `back` to use this image as the official front or back photo for the instrument.

\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"file","full_name":"file","description":"\n

A PNG or JPG and less than 5MB in size

\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a File","expected_type":"file","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["\ncurl -X POST -F \"role=front\" -F \"file=@/Users/bengotow/C0JuVkTUAAAT9J3.jpg\" -H \"Authorization: XXXXX\" \"https://api.gitfax.com/items/24/images\"\n\nUnlike other GitFax API endpoints, this endpoint requires a form/multipart-data POST.\n\nResponse:\n\n{\n \"id\": 1987,\n \"created_at\": \"2017-07-07T05:27:06.703Z\",\n \"thumb\": \"https://api.gitfax.com/images/files/000/001/987/thumb/C0JuVkTUAAAT9J3.jpg?1499405225\",\n \"small\": \"https://api.gitfax.com/images/files/000/001/987/small/C0JuVkTUAAAT9J3.jpg?1499405225\",\n \"medium\": \"https://api.gitfax.com/images/files/000/001/987/medium/C0JuVkTUAAAT9J3.jpg?1499405225\",\n \"large\": \"https://api.gitfax.com/images/files/000/001/987/large/C0JuVkTUAAAT9J3.jpg?1499405225\",\n \"original\": \"https://api.gitfax.com/images/files/000/001/987/original/C0JuVkTUAAAT9J3.jpg?1499405225\",\n \"role\": null\n}\n "],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/items-images/destroy","name":"destroy","apis":[{"api_url":"/items/:id/images/:image_id","http_method":"DELETE","short_description":"Remove an image from a GitFax item","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":["\ncurl -X DELETE -H \"Authorization: XXXXX\" \"https://api.gitfax.com/items/24/images/121\"\n\n// Returns status code 204\n "],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"items":{"doc_url":"/docs/1.0/items","id":"items","api_url":"","name":"GitFax Items","short_description":"GitFax Items represent individual instruments that have been reported by their owners or by GitFax partners. They have serial numbers, a single set of trait values, and a brand, model, and submodel.","full_description":"\n

Example JSON Representation ↑

\n\n
{\n  "id": 16,\n  "trait_values": {\n     "head_inlay": {\n       value: "PRS Bird"\n     },\n     "fingerboard_material": {\n       "value": "Ebony",\n       "description": "Diospyros ebenum",\n       "metadata": {\n         "Source": "Africa"\n       }\n     }\n  },\n  "history": [\n    {\n      "changes": {\n        "head_inlay": {\n          "old": "Gretsch Horseshoe",\n          "new": "PRS Bird"\n        }\n      },\n      "created_at": "2016-12-07T08:03:57.732Z",\n      "description": ""\n    }\n  ],\n  "brand": {\n    "id": 2,\n    "name": "Fender",\n    "approved": true,\n    "type": "guitar"\n  },\n  "model": {\n    "id": 239,\n    "name": "Stratocaster",\n    "approved": true,\n    "brand_id": 2\n  }\n}\n
\n","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/items/index","name":"index","apis":[{"api_url":"/items","http_method":"GET","short_description":"List GitFax items or retrieve items matching a serial number / RFID.","deprecated":null}],"formats":["json"],"full_description":"\n

Returns GitFax items matching the criteria you provide. To search the records for a particlar serial number, pass ?serial_number=X. Note that there may be multiple matches for any given serial number, and you can paginate through results by passing the ?page= option.

\n","errors":[{"code":400,"description":"The request was unacceptable, often due to missing a required parameter.","metadata":null}],"params":[{"name":"page","full_name":"page","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"serial_number","full_name":"serial_number","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"rfid_value","full_name":"rfid_value","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["\ncurl -X GET -H \"Authorization: XXXXX\" \"https://api.gitfax.com/items?serial_number=AAA1A34\"\n\n{\n \"pagination\": {\n \"per_page\": 25,\n \"total_pages\": 1,\n \"total_objects\": 1\n },\n \"items\": [\n {\n \"id\": 16,\n \"trait_values\": {\n \"head_inlay\": {\n value: \"PRS Bird\"\n },\n \"fingerboard_material\": {\n \"value\": \"Ebony\",\n \"description\": \"Diospyros ebenum\",\n \"metadata\": {\n \"Source\": \"Africa\"\n }\n }\n },\n \"history\": [\n {\n \"changes\": {\n \"head_inlay\": {\n \"old\": \"Gretsch Horseshoe\",\n \"new\": \"PRS Bird\"\n }\n },\n \"created_at\": \"2016-12-07T08:03:57.732Z\",\n \"description\": \"\"\n }\n ],\n \"brand\": {\n \"id\": 2,\n \"name\": \"Fender\",\n \"approved\": true,\n \"type\": \"guitar\"\n },\n \"model\": {\n \"id\": 239,\n \"name\": \"Stratocaster\",\n \"approved\": true,\n \"brand_id\": 2\n }\n }\n ]\n}\n "],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/items/show","name":"show","apis":[{"api_url":"/items/:id","http_method":"GET","short_description":"Show a GitFax item","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":400,"description":"The request was unacceptable, often due to missing a required parameter.","metadata":null}],"params":[],"returns":[],"examples":["\ncurl -X GET -H \"Authorization: XXXXX\" \"https://api.gitfax.com/items/24\"\n\n{\n \"gitfax_item\": {\n \"id\": 16,\n \"trait_values\": {\n \"head_inlay\": {\n value: \"PRS Bird\"\n },\n \"fingerboard_material\": {\n \"value\": \"Ebony\",\n \"description\": \"Diospyros ebenum\",\n \"metadata\": {\n \"Source\": \"Africa\"\n }\n }\n },\n \"history\": [\n {\n \"changes\": {\n \"head_inlay\": {\n \"old\": \"Gretsch Horseshoe\",\n \"new\": \"PRS Bird\"\n }\n },\n \"created_at\": \"2016-12-07T08:03:57.732Z\",\n \"description\": \"\"\n }\n ],\n \"brand\": {\n \"id\": 2,\n \"name\": \"Fender\",\n \"approved\": true,\n \"type\": \"guitar\"\n },\n \"model\": {\n \"id\": 239,\n \"name\": \"Stratocaster\",\n \"approved\": true,\n \"brand_id\": 2\n }\n }\n}\n "],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/items/create","name":"create","apis":[{"api_url":"/items","http_method":"POST","short_description":"Create a GitFax item","deprecated":null}],"formats":["json"],"full_description":"\n

Create the GitFax item by passing AxeFax brand, model and submodel IDs, serial number and/or RFID value, and any specific traits identified on this particular instrument. Note that a serial number or RIFD value is required, and cannot be changed once the record is created.

\n","errors":[{"code":400,"description":null,"metadata":null}],"params":[{"name":"name","full_name":"name","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"customer_id","full_name":"customer_id","description":"\n

When using the Appraisals API, provide the customer ID which owns the GitFax instrument

\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"brand_id","full_name":"brand_id","description":"\n

The brand ID of the instrument. You may also provide a brand name by passing ‘brand` instead.

\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"brand","full_name":"brand","description":"\n

The brand name of the instrument. You may also provide a brand ID by passing ‘brand_id` instead.

\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"model_id","full_name":"model_id","description":"\n

The model ID of the instrument within it’s brand.

\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"model","full_name":"model","description":"\n

The model name of the instrument within it’s brand.

\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"submodel_id","full_name":"submodel_id","description":"\n

The submodel ID of the instrument within it’s brand.

\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"submodel","full_name":"submodel","description":"\n

The submodel name of the instrument within it’s brand.

\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"year","full_name":"year","description":"\n

The year of manufacture.

\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"serial_number","full_name":"serial_number","description":"\n

The serial number of the instrument that uniquely idenfities it. You may pass ‘rfid_value` instead if you are not using serial numbers.

\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"rfid_value","full_name":"rfid_value","description":"\n

The RFID tag value of the instrument that uniquely idenfities it. You may pass ‘serial_number` instead if you are not using RFIDs.

\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["\ncurl -X POST -d '{\"brand_id\": 2, \"model_id\": 239, \"serial_number\": \"AAA1A34\", \"head_inlay\":926}' -H \"Content-type: application/json\" -H \"Authorization: XXXXX\" \"https://api.gitfax.com/items\"\n\n// Returns the newly created record\n "],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/items/update","name":"update","apis":[{"api_url":"/items/:id","http_method":"PUT","short_description":"Update a GitFax item","deprecated":null}],"formats":["json"],"full_description":"\n

Modify the GitFax item by passing new trait value IDs for trait values. Changes you make are permanently logged to the item’s history and update its modification date. An item’s serial number and/or RFID value cannot be changed after it is created.

\n","errors":[{"code":400,"description":null,"metadata":null}],"params":[{"name":"name","full_name":"name","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"customer_id","full_name":"customer_id","description":"\n

When using the Appraisals API, provide the customer ID which owns the GitFax instrument

\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"brand_id","full_name":"brand_id","description":"\n

The brand ID of the instrument. You may also provide a brand name by passing ‘brand` instead.

\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"brand","full_name":"brand","description":"\n

The brand name of the instrument. You may also provide a brand ID by passing ‘brand_id` instead.

\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"model_id","full_name":"model_id","description":"\n

The model ID of the instrument within it’s brand.

\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"model","full_name":"model","description":"\n

The model name of the instrument within it’s brand.

\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"submodel_id","full_name":"submodel_id","description":"\n

The submodel ID of the instrument within it’s brand.

\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"submodel","full_name":"submodel","description":"\n

The submodel name of the instrument within it’s brand.

\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"year","full_name":"year","description":"\n

The year of manufacture.

\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"serial_number","full_name":"serial_number","description":"\n

The serial number of the instrument that uniquely idenfities it. You may pass ‘rfid_value` instead if you are not using serial numbers.

\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"rfid_value","full_name":"rfid_value","description":"\n

The RFID tag value of the instrument that uniquely idenfities it. You may pass ‘serial_number` instead if you are not using RFIDs.

\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["\ncurl -X PUT -d '{\"head_inlay\":926}' -H \"Content-type: application/json\" -H \"Authorization: XXXXX\" \"https://api.gitfax.com/items/24\"\n\n// Returns the same response as GET /items/:id\n "],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/items/destroy","name":"destroy","apis":[{"api_url":"/items/:id","http_method":"DELETE","short_description":"Destroy a GitFax item","deprecated":null}],"formats":["json"],"full_description":"\n

Note: You must be a GitFax administrator to use this API. Because GitFax stores permanent records of instrument manufacture and maintenance, deleting records is not common.

\n","errors":[{"code":400,"description":"The request was unacceptable, often due to missing a required parameter.","metadata":null}],"params":[],"returns":[],"examples":["\ncurl -X DELETE -H \"Authorization: XXXXX\" \"https://api.gitfax.com/items/24\"\n\n// Returns status code 204\n "],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"instruments":{"doc_url":"/docs/1.0/instruments","id":"instruments","api_url":"","name":"Instruments","short_description":"Instruments represent a specific product sold by a manufacturers. You can query instruments and get a wide range of attributes (called Traits), their production years, and more.","full_description":"\n

Example JSON Representation ↑

\n\n
{\n  "id": 1846,\n  "approved": true,\n  "trait_values": {\n    "fingerboard_inlay": [\n      "Dots-centered"\n    ],\n    "number_of_strings": [\n      "6"\n    ],\n    "number_of_pickups": [\n      "1"\n    ],\n    "pickup_1": [\n      "Transducer",\n      "Magnetic"\n    ],\n    "soundhole": [\n      "4 Crescent-Shaped"\n    ],\n    "body_shape": [\n      "Dobro Woodbody Guitar Shape"\n    ]\n  },\n  "year_start": 1954,\n  "year_end": 1954,\n  "brand": {\n    "id": 2,\n    "name": "Fender",\n    "approved": true\n  },\n  "model": {\n    "id": 2530,\n    "name": "1954 Stratocaster",\n    "approved": true,\n    "brand_id": 2\n  },\n  "submodel": null,\n  "images": []\n}\n
\n","version":"1.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/docs/1.0/instruments/index","name":"index","apis":[{"api_url":"/instruments","http_method":"GET","short_description":"List and filter instruments.","deprecated":null}],"formats":["json"],"full_description":"\n

You must provide a brand or brand_id and a model or model_id to retrieve results. If you are using admin credentials to access the API you may omit these parameters but you should consider caching the results within your application. In addition to filtering based on the parameters below, you can pass <trait_name>:<trait value id> to filter by any instrument trait.

\n","errors":[{"code":400,"description":"The request was unacceptable, often due to missing a required parameter.","metadata":null}],"params":[{"name":"page","full_name":"page","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"shallow","full_name":"shallow","description":"\n

Pass true to include trait values, or false to include the IDs of values (faster). Default: false.

\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be true or false.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"brand","full_name":"brand","description":"\n

Filter based on a brand name

\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"brand_id","full_name":"brand_id","description":"\n

Filter based on a brand id

\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"model_id","full_name":"model_id","description":"\n

Filter based on a model id

\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"submodel_id","full_name":"submodel_id","description":"\n

Filter based on a submodel id

\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"year","full_name":"year","description":"\n

Filter based on a year

\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"serial_number","full_name":"serial_number","description":"\n

Filter based on a year provided by a serial number

\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"approved","full_name":"approved","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be true or false.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pending","full_name":"pending","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be true or false.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["\ncurl -X GET -H \"Authorization: XXXXX\" \"https://api.axefax.com/instruments?brand=fender&serial_number=4900&model_id=2530\"\n\n{\n \"pagination\": {\n \"per_page\": 25,\n \"total_pages\": 1,\n \"total_objects\": 6\n },\n \"instruments\": [\n {\n \"id\": 1846,\n \"approved\": true,\n \"trait_values\": {\n \"fingerboard_inlay\": [\n \"Dots-centered\"\n ],\n \"number_of_strings\": [\n \"6\"\n ],\n \"number_of_pickups\": [\n \"1\"\n ],\n \"pickup_1\": [\n \"Transducer\",\n \"Magnetic\"\n ],\n \"soundhole\": [\n \"4 Crescent-Shaped\"\n ],\n \"body_shape\": [\n \"Dobro Woodbody Guitar Shape\"\n ]\n },\n \"year_start\": 1954,\n \"year_end\": 1954,\n \"brand\": {\n \"id\": 2,\n \"name\": \"Fender\",\n \"approved\": true\n },\n \"model\": {\n \"id\": 2530,\n \"name\": \"1954 Stratocaster\",\n \"approved\": true,\n \"brand_id\": 2\n },\n \"submodel\": null,\n \"images\": []\n },\n ....\n ],\n \"serial_number_ranges\": [\n {\n \"id\": 122,\n \"name\": \"FENDER\",\n \"years\": \"1950 - 1954\",\n \"brand_id\": 2,\n \"created_at\": \"2016-01-12T22:27:43.964Z\",\n \"updated_at\": \"2016-01-12T22:28:08.424Z\",\n \"instrument_id\": null\n }\n ]\n}\n]\n ","GET /instruments\n200\n{\n \"pagination\": {\n \"per_page\": 25,\n \"total_pages\": 0,\n \"total_objects\": 0\n },\n \"instruments\": [],\n \"serial_number_ranges\": []\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/instruments/traits_with_variance","name":"traits_with_variance","apis":[{"api_url":"/instruments/traits-with-variance","http_method":"GET","short_description":"List the distinict values possible for each trait for instruments matching the filters.","deprecated":null}],"formats":["json"],"full_description":"\n

You must provide a brand or brand_id and a model or model_id to retrieve possible traits. Ideally, your application should fetch /traits-with-variance once the user has selected a brand, model and/or submodel. If you are using admin credentials to access the API you may omit these parameters but you should consider caching the results within your application.

\n\n

By default, this API returns a set of possibilities for every trait. If you only need information about one trait, or a handful of traits, use the only parameter to improve performance (ex: ?only=fingerboard_inlay,truss_rod)

\n","errors":[{"code":400,"description":"The request was unacceptable, often due to missing a required parameter.","metadata":null}],"params":[{"name":"shallow","full_name":"shallow","description":"\n

Pass true to include trait values, or false to include the IDs of values (faster). Default: false.

\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be true or false.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"only","full_name":"only","description":"\n

Pass a comma-separated list of trait keys to look up variance for only those traits. Limiting your search can make the API much faster. For ex: &only=fingerboard_inlay,truss_rod

\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"brand","full_name":"brand","description":"\n

Filter based on a brand name

\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"brand_id","full_name":"brand_id","description":"\n

Filter based on a brand id

\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"model","full_name":"model","description":"\n

Filter based on a model name

\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"model_id","full_name":"model_id","description":"\n

Filter based on a model id

\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"submodel","full_name":"submodel","description":"\n

Filter based on a submodel name

\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"submodel_id","full_name":"submodel_id","description":"\n

Filter based on a submodel id

\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"year","full_name":"year","description":"\n

Filter based on a year

\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"serial_number","full_name":"serial_number","description":"\n

Filter based on a year provided by a serial number

\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"approved","full_name":"approved","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be true or false.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pending","full_name":"pending","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be true or false.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["\ncurl -X GET -H \"Authorization: XXXXX\" \"https://api.axefax.com/instruments/traits-with-variance?brand=fender&model=Stratocaster&serial_number=4900\"\n\n{\n \"number_of_strings\": [\n {\n \"id\": 1954,\n \"value\": \"6\",\n \"description\": \"None provided.\"\n }\n ],\n \"body_shape\": [\n {\n \"id\": 36,\n \"value\": \"Stratocaster\",\n \"description\": \"None provided.\"\n }\n ],\n \"top\": [\n {\n \"id\": 2303,\n \"value\": \"13 Body 27 Top\",\n \"description\": \"None provided.\"\n },\n {\n \"id\": 2305,\n \"value\": \"8 Body 27 Top\",\n \"description\": \"None provided.\"\n }\n ],\n \"back_and_sides\": [],\n \"body_width\": [],\n \"body_length\": [],\n \"body_thickness\": [],\n \"soundhole\": [\n {\n \"id\": 264,\n \"value\": \"None\",\n \"description\": \"None provided.\"\n }\n ],\n ...\n}\n "],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/instruments/show","name":"show","apis":[{"api_url":"/instruments/:id","http_method":"GET","short_description":"Show an instrument","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":400,"description":"The request was unacceptable, often due to missing a required parameter.","metadata":null}],"params":[{"name":"shallow","full_name":"shallow","description":"\n

Pass true to include trait values, or false to include the IDs of values (faster).

\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be true or false.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /instruments/468\n200\n{\n \"id\": 468,\n \"approved\": false,\n \"trait_values\": {},\n \"type\": \"Guitars\",\n \"year_start\": null,\n \"year_end\": null,\n \"brand\": {\n \"id\": 4307,\n \"name\": \"Treck1f91dbab-199e-476e-94bd-20f182804d0e\",\n \"approved\": true,\n \"type\": \"Guitars\"\n },\n \"model\": {\n \"id\": 3430,\n \"name\": \"B620e9ede4e-fd7a-430f-a17e-73d3df1c2258\",\n \"approved\": false,\n \"brand_id\": 4307\n },\n \"submodel\": {\n \"id\": 1890,\n \"name\": \"Nichole Bechtelarcfdfd929-a121-4d78-9052-618735d53436\",\n \"approved\": false,\n \"brand_id\": 4307,\n \"model_id\": 3430\n },\n \"images\": []\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/instruments/create","name":"create","apis":[{"api_url":"/instruments","http_method":"POST","short_description":"Create an instrument","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":400,"description":null,"metadata":null}],"params":[{"name":"name","full_name":"name","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"brand_id","full_name":"brand_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"model_id","full_name":"model_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"submodel_id","full_name":"submodel_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["POST /instruments\n{\n \"brand_id\": 4308,\n \"model_id\": 3431,\n \"submodel_id\": 1891,\n \"instrument\": {\n \"brand_id\": 4308,\n \"model_id\": 3431,\n \"submodel_id\": 1891\n }\n}\n201\n{\n \"id\": 469,\n \"approved\": false,\n \"trait_values\": {},\n \"type\": \"Guitars\",\n \"year_start\": null,\n \"year_end\": null,\n \"brand\": {\n \"id\": 4308,\n \"name\": \"Casyncf6b8974f-617e-455d-8421-c2ef5d15baae\",\n \"approved\": true,\n \"type\": \"Guitars\"\n },\n \"model\": {\n \"id\": 3431,\n \"name\": \"M-27843c87b952-eb42-4f0a-a918-94bc3834e25b\",\n \"approved\": false,\n \"brand_id\": 4308\n },\n \"submodel\": {\n \"id\": 1891,\n \"name\": \"Tyree Reynoldscc50590a-f42a-4c85-a097-c5dd79eef14b\",\n \"approved\": false,\n \"brand_id\": 4308,\n \"model_id\": 3431\n },\n \"images\": []\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/instruments/update","name":"update","apis":[{"api_url":"/instruments/:id","http_method":"PUT","short_description":"Update an instrument","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":400,"description":null,"metadata":null}],"params":[{"name":"name","full_name":"name","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"brand_id","full_name":"brand_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"model_id","full_name":"model_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"submodel_id","full_name":"submodel_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["PATCH /instruments/470\n{\n \"submodel_id\": 1893,\n \"instrument\": {\n \"submodel_id\": 1893\n }\n}\n202\n{\n \"id\": 470,\n \"approved\": false,\n \"trait_values\": {},\n \"type\": \"Guitars\",\n \"year_start\": null,\n \"year_end\": null,\n \"brand\": {\n \"id\": 4309,\n \"name\": \"Brancea5d4b3f1-112a-4565-b617-711208cc90be\",\n \"approved\": true,\n \"type\": \"Guitars\"\n },\n \"model\": {\n \"id\": 3432,\n \"name\": \"KO-9560f77a123d-0f8c-4837-934b-4b202623fbf5\",\n \"approved\": false,\n \"brand_id\": 4309\n },\n \"submodel\": {\n \"id\": 1893,\n \"name\": \"Arianna Zemlak5f965600-477c-4b2d-b288-dc1a5a560fd3\",\n \"approved\": true,\n \"brand_id\": 4309,\n \"model_id\": 3432\n },\n \"images\": []\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/instruments/destroy","name":"destroy","apis":[{"api_url":"/instrument/:id","http_method":"DELETE","short_description":"Destroy an instrument","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":400,"description":"The request was unacceptable, often due to missing a required parameter.","metadata":null}],"params":[],"returns":[],"examples":["DELETE /instruments/472\n{\n \"instrument\": {}\n}\n204"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"model":{"doc_url":"/docs/1.0/model","id":"model","api_url":"","name":"Models","short_description":"Each Brand has one or more Models, which represent a\n group of instruments. (Ex: Fender > Telecaster)","full_description":"\n

Example JSON Representation ↑

\n\n
{\n  "id": 5052,\n  "brand_id":549,\n  "name":"New Model A",\n  "approved":false\n}\n
\n","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/docs/1.0/model/index","name":"index","apis":[{"api_url":"/models","http_method":"GET","short_description":"List models","deprecated":null},{"api_url":"/brands/:id/models","http_method":"GET","short_description":"List models","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"page","full_name":"page","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n

List models with names matching the provided string.

\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name_like","full_name":"name_like","description":"\n

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

\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"brand","full_name":"brand","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"brand_id","full_name":"brand_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"approved","full_name":"approved","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be true or false.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pending","full_name":"pending","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be true or false.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"in_use","full_name":"in_use","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be true or false.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /models\n200\n{\n \"pagination\": {\n \"per_page\": 25,\n \"total_pages\": 0,\n \"total_objects\": 0\n },\n \"models\": []\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/model/show","name":"show","apis":[{"api_url":"/models/:id","http_method":"GET","short_description":"Show a model","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":["GET /models/3436\n200\n{\n \"id\": 3436,\n \"name\": \"O30acb4bb72-ae2a-4f22-93d3-cbf924d5b1d7\",\n \"approved\": true,\n \"brand_id\": 4313\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/model/create","name":"create","apis":[{"api_url":"/models","http_method":"POST","short_description":"Create a model","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":400,"description":null,"metadata":null}],"params":[{"name":"name","full_name":"name","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"brand_id","full_name":"brand_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["\ncurl -X POST -H \"Authorization: XXXX\" -H \"Content-Type: application/json\" -d '{\"name\": \"New Model A\", \"brand_id\": 549}' \"https://api.axefax.com/models\"\n\nResponse:\n\n{\n \"model\":{\n \"id\": 5052,\n \"brand_id\":549,\n \"name\":\"New Model A\",\n \"approved\":false\n }\n}\n ","POST /models\n{\n \"name\": \"A-6099b6b808dd-d96f-45fa-921a-9a51f5038d97\",\n \"model\": {\n \"name\": \"A-6099b6b808dd-d96f-45fa-921a-9a51f5038d97\"\n }\n}\n201\n{\n \"id\": 3437,\n \"name\": \"A-6099b6b808dd-d96f-45fa-921a-9a51f5038d97\",\n \"approved\": false,\n \"brand_id\": null\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/model/update","name":"update","apis":[{"api_url":"/models/:id","http_method":"PUT","short_description":"Update a model","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":400,"description":null,"metadata":null}],"params":[{"name":"name","full_name":"name","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"brand_id","full_name":"brand_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["PATCH /models/3439\n{\n \"name\": \"Stratocaster\",\n \"model\": {\n \"name\": \"Stratocaster\"\n }\n}\n202\n{\n \"id\": 3439,\n \"name\": \"Stratocaster\",\n \"approved\": false,\n \"brand_id\": 4314\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/model/destroy","name":"destroy","apis":[{"api_url":"/models/:id","http_method":"DELETE","short_description":"Destroy a model","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":405,"description":null,"metadata":null}],"params":[],"returns":[],"examples":["DELETE /models/3444\n{\n \"model\": {}\n}\n204"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"serial_number_ranges":{"doc_url":"/docs/1.0/serial_number_ranges","id":"serial_number_ranges","api_url":"","name":"Serial Numbers","short_description":null,"full_description":"\n

Example JSON Representation ↑

\n\n
{\n  "name": "Fender Stratacaster",\n  "years": "1950 - 1954",\n  "year_start": 1950,\n  "year_end": 1954,\n  "brand": null\n}\n
\n","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/docs/1.0/serial_number_ranges/index","name":"index","apis":[{"api_url":"/serial-lookup","http_method":"GET","short_description":"Identify brand and instrument years given a serial number","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"serial","full_name":"serial","description":"\n

An instrument serial number

\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"brand_id","full_name":"brand_id","description":"\n

The ID of the brand, if known. If you do not provide a brand ID or name, lookup may take longer.

\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"brand_name","full_name":"brand_name","description":"\n

The name of the brand, if known. If you do not provide a brand ID or name, lookup may take longer.

\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["\n[\n {\n \"name\": \"Fender Stratacaster\",\n \"years\": \"1950 - 1954\",\n \"year_start\": 1950,\n \"year_end\": 1954,\n \"brand\": null\n },\n {\n \"name\": \"Fender Stratacaster\",\n \"years\": \"1898\",\n \"year_start\": 1898,\n \"year_end\": 1898,\n \"brand\": null\n }\n]\n "],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"submodel":{"doc_url":"/docs/1.0/submodel","id":"submodel","api_url":"","name":"Submodels","short_description":"Models may be divided into Submodels that represent\n distinictions within a product line.\n (ex: Fender > Telecaster > Sparkle Telecaster)","full_description":"\n

Example JSON Representation ↑

\n\n
{\n  "id": 7977,\n  "brand_id":478,\n  "model_id":12432,\n  "name":"Electric Lap Steel",\n  "approved":true\n}\n
\n","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/docs/1.0/submodel/index","name":"index","apis":[{"api_url":"/submodels","http_method":"GET","short_description":"List submodels","deprecated":null},{"api_url":"/brands/:id/models/:model_id/submodels","http_method":"GET","short_description":"List submodels","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"page","full_name":"page","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name","full_name":"name","description":"\n

List submodels with names matching the provided string.

\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"name_like","full_name":"name_like","description":"\n

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

\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"model","full_name":"model","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"model_id","full_name":"model_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"brand","full_name":"brand","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"brand_id","full_name":"brand_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"approved","full_name":"approved","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be true or false.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pending","full_name":"pending","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be true or false.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /submodels\n200\n{\n \"pagination\": {\n \"per_page\": 25,\n \"total_pages\": 0,\n \"total_objects\": 0\n },\n \"submodels\": []\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/submodel/show","name":"show","apis":[{"api_url":"/submodels/:id","http_method":"GET","short_description":"Show a submodel","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":["GET /submodels/1898\n200\n{\n \"id\": 1898,\n \"name\": \"Genesis Weber3ed9c3a1-c9a6-467e-8a3b-d63fa2a3d082\",\n \"approved\": true,\n \"brand_id\": 4321,\n \"model_id\": 3446\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/submodel/create","name":"create","apis":[{"api_url":"/submodels","http_method":"POST","short_description":"Create a submodel","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":400,"description":null,"metadata":null}],"params":[{"name":"name","full_name":"name","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"brand_id","full_name":"brand_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"model_id","full_name":"model_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["\ncurl -X POST -H \"Authorization: XXXXX\" -H \"Content-Type: application/json\" -d '{\"name\": \"New Submodel B\", \"brand_id\": 549, \"model_id\": 5052}' \"https://api.axefax.com/submodels\"\n\nResponse:\n\n{\n \"submodel\":{\n \"id\": 7977,\n \"brand_id\":478,\n \"model_id\":12432,\n \"name\":\"Electric Lap Steel\",\n \"approved\":true\n }\n}\n ","POST /submodels\n{\n \"name\": \"Lourdes Prohaska699354e4-9c69-49b8-bba6-3f529a053b82\",\n \"model_id\": 3447,\n \"submodel\": {\n \"name\": \"Lourdes Prohaska699354e4-9c69-49b8-bba6-3f529a053b82\",\n \"model_id\": 3447\n }\n}\n201\n{\n \"id\": 1900,\n \"name\": \"Lourdes Prohaska699354e4-9c69-49b8-bba6-3f529a053b82\",\n \"approved\": false,\n \"brand_id\": 4322,\n \"model_id\": 3447\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/submodel/update","name":"update","apis":[{"api_url":"/submodels/:id","http_method":"PUT","short_description":"Update a submodel","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":400,"description":null,"metadata":null}],"params":[{"name":"name","full_name":"name","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"brand_id","full_name":"brand_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"model_id","full_name":"model_id","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["PATCH /submodels/1903\n{\n \"name\": \"Fender\",\n \"submodel\": {\n \"name\": \"Fender\"\n }\n}\n202\n{\n \"id\": 1903,\n \"name\": \"Fender\",\n \"approved\": false,\n \"brand_id\": 4324,\n \"model_id\": 3449\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/submodel/destroy","name":"destroy","apis":[{"api_url":"/submodels/:id","http_method":"DELETE","short_description":"Destroy a submodel","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":405,"description":null,"metadata":null}],"params":[],"returns":[],"examples":["DELETE /submodels/1908\n{\n \"submodel\": {}\n}\n204"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"traits":{"doc_url":"/docs/1.0/traits","id":"traits","api_url":"","name":"Traits","short_description":"A Trait represents an instrument attribute (ex: Number of Strings).","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/docs/1.0/traits/index","name":"index","apis":[{"api_url":"/traits","http_method":"GET","short_description":"List traits","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"page","full_name":"page","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"in_use","full_name":"in_use","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be true or false.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"approved","full_name":"approved","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be true or false.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pending","full_name":"pending","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be true or false.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["GET /traits\n200\n{\n \"pagination\": {\n \"per_page\": 25,\n \"total_pages\": 0,\n \"total_objects\": 0\n },\n \"traits\": []\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/traits/show","name":"show","apis":[{"api_url":"/traits/:id","http_method":"GET","short_description":"Show a trait","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":["GET /traits/1367\n200\n{\n \"id\": 1367,\n \"column_name\": \"test-column-name\",\n \"display_name\": \"Nash McLaughlind4c07d13-50c5-4ce9-a21f-16c70f160929\",\n \"description\": \"Nihil illum ut dignissimos ratione explicabo ut consequatur.\",\n \"position\": null,\n \"hidden\": false,\n \"type\": \"Guitars\",\n \"permitted_additional_keys\": null,\n \"image\": null\n}"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"trait_values":{"doc_url":"/docs/1.0/trait_values","id":"trait_values","api_url":"","name":"Trait Values","short_description":"A TraitValue represents a possible value of a Trait\n (ex: Number of Strings: 6), and may include images\n and more details.","full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/docs/1.0/trait_values/index","name":"index","apis":[{"api_url":"/traits/values","http_method":"GET","short_description":"List values for the traits in the `?only=` query parameter","deprecated":null},{"api_url":"/traits/:trait/values","http_method":"GET","short_description":"List values for a particular trait. `:trait` can be a trait key or ID","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"page","full_name":"page","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"per_page","full_name":"per_page","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"only","full_name":"only","description":"\n

An optional set of comma-separated trait column names. When you pass a specific set of column names (eg: ‘?column_name=fingerboard_inlay,neck_binding`), the JSON response is an object with an array of results for each requested column name.

\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"in_use","full_name":"in_use","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be true or false.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"approved","full_name":"approved","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be true or false.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pending","full_name":"pending","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be true or false.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["\n\"pagination\": {\n \"per_page\": 25,\n \"total_pages\": 6,\n \"total_objects\": 135\n},\n\"trait_values\": [\n {\n \"id\": 1,\n \"column_name\": \"body_shape\",\n \"column_value\": \"Round Body (Rhumba)\",\n \"description\": \"None provided.\",\n \"approved\": true,\n \"image\": {\n \"thumb\": \"http://s3.amazonaws.com/eb-api-images/images/files/000/000/416/thumb/01.jpg?1451585446\",\n \"small\": \"http://s3.amazonaws.com/eb-api-images/images/files/000/000/416/small/01.jpg?1451585446\",\n \"medium\": \"http://s3.amazonaws.com/eb-api-images/images/files/000/000/416/medium/01.jpg?1451585446\",\n \"large\": \"http://s3.amazonaws.com/eb-api-images/images/files/000/000/416/large/01.jpg?1451585446\",\n \"original\": \"http://s3.amazonaws.com/eb-api-images/images/files/000/000/416/original/01.jpg?1451585446\"\n }\n },\n {\n \"id\": 2,\n \"column_name\": \"body_shape\",\n \"column_value\": \"Rect (Bo Diddley)\",\n \"description\": \"None provided.\",\n \"approved\": true,\n \"image\": {\n \"thumb\": \"http://s3.amazonaws.com/eb-api-images/images/files/000/000/767/thumb/Bo_diddley.jpg?1453227527\",\n \"small\": \"http://s3.amazonaws.com/eb-api-images/images/files/000/000/767/small/Bo_diddley.jpg?1453227527\",\n \"medium\": \"http://s3.amazonaws.com/eb-api-images/images/files/000/000/767/medium/Bo_diddley.jpg?1453227527\",\n \"large\": \"http://s3.amazonaws.com/eb-api-images/images/files/000/000/767/large/Bo_diddley.jpg?1453227527\",\n \"original\": \"http://s3.amazonaws.com/eb-api-images/images/files/000/000/767/original/Bo_diddley.jpg?1453227527\"\n }\n }\n ...\n]\n ","GET /traits/1368/values\n200\n{\n \"pagination\": {\n \"per_page\": 25,\n \"total_pages\": 0,\n \"total_objects\": 0\n },\n \"trait_values\": []\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/trait_values/show","name":"show","apis":[{"api_url":"/traits/:trait/values/:id","http_method":"GET","short_description":"Show a trait value","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/trait_values/create","name":"create","apis":[{"api_url":"/traits/:trait/values","http_method":"POST","short_description":"Create a trait value","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":400,"description":null,"metadata":null}],"params":[{"name":"name","full_name":"name","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"column_value","full_name":"column_value","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n

An optional description

\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["\ncurl -X POST -H \"Content-Type: application/json\" -d '{\"column_name\": \"number_of_strings\", \"column_value\": \"100\", \"description\": \"100 strings!\"}' -H \"Authorization: XXXX\" http://localhost:3000/traits/number_of_strings/values\n\n{\n\t\"trait_value\": {\n\t\t\"id\": 5634,\n\t\t\"column_name\": \"number_of_strings\",\n\t\t\"column_value\": \"100\",\n\t\t\"description\": \"100 strings!\",\n\t\t\"approved\": false,\n\t\t\"image\": null\n\t}\n}\n ","POST /traits/1380/values\n{\n \"column_name\": \"test-column-name\",\n \"column_value\": \"Tony Kshlerin1a3ad207-35ca-4eba-b3d3-ba241f6948b0\",\n \"description\": \"Non voluptatem repellendus vero nobis temporibus autem minus a.\",\n \"trait_value\": {\n \"column_name\": \"test-column-name\",\n \"column_value\": \"Tony Kshlerin1a3ad207-35ca-4eba-b3d3-ba241f6948b0\",\n \"description\": \"Non voluptatem repellendus vero nobis temporibus autem minus a.\"\n }\n}\n201\n{\n \"id\": 601,\n \"column_name\": \"test-column-name\",\n \"column_value\": \"Tony Kshlerin1a3ad207-35ca-4eba-b3d3-ba241f6948b0\",\n \"description\": \"Non voluptatem repellendus vero nobis temporibus autem minus a.\",\n \"approved\": false,\n \"position\": null,\n \"image\": null\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/trait_values/update","name":"update","apis":[{"api_url":"/traits/:trait/values/:id","http_method":"PUT","short_description":"Update a trait value","deprecated":null}],"formats":null,"full_description":"","errors":[{"code":400,"description":null,"metadata":null}],"params":[{"name":"name","full_name":"name","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"column_value","full_name":"column_value","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"description","full_name":"description","description":"\n

An optional description

\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["PATCH /traits/1386/values/604\n{\n \"column_value\": \"red\",\n \"trait_value\": {\n \"column_value\": \"red\"\n }\n}\n202\n{\n \"id\": 604,\n \"column_name\": \"test-column-name\",\n \"column_value\": \"red\",\n \"description\": \"Distinctio nesciunt porro consequuntur odit.\",\n \"approved\": false,\n \"position\": null,\n \"image\": null\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/docs/1.0/trait_values/destroy","name":"destroy","apis":[{"api_url":"/traits/:trait/values/:id","http_method":"DELETE","short_description":"Destroy a trait value","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":["DELETE /traits/1391/values/609\n{\n \"trait_value\": {}\n}\n204"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false}}}}