{"docs":{"name":"AxeFax","info":"\n
The AxeFax API allows developers with valid API tokens to query a wide\nrange of information about instruments. To get a token for your\napplication, contact Joe Glaser.
\n\nThe AxeFax API may be accessed from api.axefax.com, or from an instrument\nsubdomain (guitars.axefax.com, amps.axefax.com, etc.) When using a\nsubdomain, your API requests are automatically scoped by instrument type.\nFor example, amps.axefax.com/brands will only\nreturn brands of amps.
\n\nNote that if you use the top-level api.axefax.com domain, you can find,\nupdate and delete all types of instruments, and they will appear mixed\ntogether. To create brands, models, submodels or instruments from the top\nlevel domain, you need to specify a `?type_id=` manually, which indicates\nwhether the item is for Guitars, Amps, etc. Valid types are listed at api.axefax.com/admin/types
\n\nIf you're using the Admin Dashboard, you can access it from any domain\nand it is also scoped to the instrument type, with one caveat: you cannot\ncreate or edit instruments from the top-level admin dashboard. Because form\nfields depend on the type of instrument, you need to author and edit\ninstruments from the Admin dashboard of the instrument subdomain.
\n","copyright":"© 2024 GitSuite","doc_url":"/docs/1.0","api_url":"","resources":{"brand":{"doc_url":"/docs/1.0/brand","api_url":"","name":"Brands","short_description":"Brands are the top level categorization of instruments. (ex: Fender)","full_description":"\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,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"","required":false,"allow_nil":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true},{"name":"name","full_name":"name","description":"\n
List brands with names matching the provided string.
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"name_like","full_name":"name_like","description":"\nList brands with names matching, or similar to, the provided string.\nSlower, but useful for correcting user input.
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"approved","full_name":"approved","description":"","required":false,"allow_nil":false,"validator":"Must be true or false.","expected_type":"string","metadata":null,"show":true},{"name":"pending","full_name":"pending","description":"","required":false,"allow_nil":false,"validator":"Must be true or false.","expected_type":"string","metadata":null,"show":true},{"name":"in_use","full_name":"in_use","description":"\nOnly return brands that have one or more instrument.
\n","required":false,"allow_nil":false,"validator":"Must be true or false.","expected_type":"string","metadata":null,"show":true},{"name":"in_serial_lookup","full_name":"in_serial_lookup","description":"\nOnly return brands that have one or more serial number ranges defined.
\n","required":false,"allow_nil":false,"validator":"Must be true or false.","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[]},{"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":[],"examples":[],"metadata":null,"see":[],"headers":[]},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"type_id","full_name":"type_id","description":"\nBrand type. Only necessary if you are using the generic API\n(api.axefax.com)
\n","required":false,"allow_nil":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true}],"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 "],"metadata":null,"see":[],"headers":[]},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"type_id","full_name":"type_id","description":"\nBrand type. Only necessary if you are using the generic API\n(api.axefax.com)
\n","required":false,"allow_nil":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[]},{"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":[],"examples":[],"metadata":null,"see":[],"headers":[]}],"headers":[]},"customers":{"doc_url":"/docs/1.0/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":"\nReturns 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,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"","required":false,"allow_nil":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[]},{"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":[],"examples":[],"metadata":null,"see":[],"headers":[]},{"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":"\nCreate 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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"last_name","full_name":"last_name","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"email","full_name":"email","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"phone","full_name":"phone","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"address","full_name":"address","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"city","full_name":"city","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"state","full_name":"state","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"zip","full_name":"zip","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[]},{"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":"\nModify the customer by passing new parameter values. Changes you make are\npermanently logged to the item's history and update its modification\ndate. An item's serial number and/or RFID value cannot be changed after\nit is created.
\n","errors":[{"code":400,"description":null,"metadata":null}],"params":[{"name":"first_name","full_name":"first_name","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"last_name","full_name":"last_name","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"email","full_name":"email","description":"","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"phone","full_name":"phone","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"address","full_name":"address","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"city","full_name":"city","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"state","full_name":"state","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"zip","full_name":"zip","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[]},{"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":"\nNote: You must be a GitFax administrator to use this API. Because GitFax\nstores permanent records of instrument manufacture and maintenance,\ndeleting records is not common.
\n","errors":[{"code":400,"description":"The request was unacceptable, often due to missing a required parameter.","metadata":null}],"params":[],"examples":[],"metadata":null,"see":[],"headers":[]}],"headers":[]},"items-images":{"doc_url":"/docs/1.0/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":[],"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":[]},{"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":[],"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":[]},{"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":"\nOptional: Pass `front` or `back` to use this image as the official front or\nback photo for the instrument.
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"file","full_name":"file","description":"\nA PNG or JPG and less than 5MB in size
\n","required":true,"allow_nil":false,"validator":"Must be File","expected_type":"string","metadata":null,"show":true}],"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":[]},{"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":[],"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":[]}],"headers":[]},"items":{"doc_url":"/docs/1.0/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{\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\nrecords for a particlar serial number, pass ?serial_number=X. Note that\nthere may be multiple matches for any given serial number, and you can\npaginate 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,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"","required":false,"allow_nil":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true},{"name":"serial_number","full_name":"serial_number","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"rfid_value","full_name":"rfid_value","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"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":[]},{"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":[],"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":[]},{"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":"\nCreate the GitFax item by passing AxeFax brand, model and submodel IDs,\nserial number and/or RFID value, and any specific traits identified on this\nparticular instrument. Note that a serial number or RIFD value is required,\nand 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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"customer_id","full_name":"customer_id","description":"\nWhen using the Appraisals API, provide the customer ID which owns the\nGitFax instrument
\n","required":false,"allow_nil":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true},{"name":"brand_id","full_name":"brand_id","description":"\nThe brand ID of the instrument. You may also provide a brand name by\npassing `brand` instead.
\n","required":true,"allow_nil":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true},{"name":"brand","full_name":"brand","description":"\nThe brand name of the instrument. You may also provide a brand ID by\npassing `brand_id` instead.
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"model_id","full_name":"model_id","description":"\nThe model ID of the instrument within it's brand.
\n","required":false,"allow_nil":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true},{"name":"model","full_name":"model","description":"\nThe model name of the instrument within it's brand.
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"submodel_id","full_name":"submodel_id","description":"\nThe submodel ID of the instrument within it's brand.
\n","required":false,"allow_nil":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true},{"name":"submodel","full_name":"submodel","description":"\nThe submodel name of the instrument within it's brand.
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"year","full_name":"year","description":"\nThe year of manufacture.
\n","required":false,"allow_nil":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true},{"name":"serial_number","full_name":"serial_number","description":"\nThe serial number of the instrument that uniquely idenfities it. You may\npass `rfid_value` instead if you are not using serial numbers.
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"rfid_value","full_name":"rfid_value","description":"\nThe RFID tag value of the instrument that uniquely idenfities it. You may\npass `serial_number` instead if you are not using RFIDs.
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"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":[]},{"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":"\nModify the GitFax item by passing new trait value IDs for trait values.\nChanges you make are permanently logged to the item's history and\nupdate its modification date. An item's serial number and/or RFID value\ncannot 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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"customer_id","full_name":"customer_id","description":"\nWhen using the Appraisals API, provide the customer ID which owns the\nGitFax instrument
\n","required":false,"allow_nil":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true},{"name":"brand_id","full_name":"brand_id","description":"\nThe brand ID of the instrument. You may also provide a brand name by\npassing `brand` instead.
\n","required":true,"allow_nil":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true},{"name":"brand","full_name":"brand","description":"\nThe brand name of the instrument. You may also provide a brand ID by\npassing `brand_id` instead.
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"model_id","full_name":"model_id","description":"\nThe model ID of the instrument within it's brand.
\n","required":false,"allow_nil":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true},{"name":"model","full_name":"model","description":"\nThe model name of the instrument within it's brand.
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"submodel_id","full_name":"submodel_id","description":"\nThe submodel ID of the instrument within it's brand.
\n","required":false,"allow_nil":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true},{"name":"submodel","full_name":"submodel","description":"\nThe submodel name of the instrument within it's brand.
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"year","full_name":"year","description":"\nThe year of manufacture.
\n","required":false,"allow_nil":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true},{"name":"serial_number","full_name":"serial_number","description":"\nThe serial number of the instrument that uniquely idenfities it. You may\npass `rfid_value` instead if you are not using serial numbers.
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"rfid_value","full_name":"rfid_value","description":"\nThe RFID tag value of the instrument that uniquely idenfities it. You may\npass `serial_number` instead if you are not using RFIDs.
\n","required":true,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"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":[]},{"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":"\nNote: You must be a GitFax administrator to use this API. Because GitFax\nstores permanent records of instrument manufacture and maintenance,\ndeleting records is not common.
\n","errors":[{"code":400,"description":"The request was unacceptable, often due to missing a required parameter.","metadata":null}],"params":[],"examples":["\ncurl -X DELETE -H \"Authorization: XXXXX\" \"https://api.gitfax.com/items/24\"\n\n// Returns status code 204\n "],"metadata":null,"see":[],"headers":[]}],"headers":[]},"instruments":{"doc_url":"/docs/1.0/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{\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\nresults. If you are using admin credentials to access the API you may omit\nthese parameters but you should consider caching the results within your\napplication. In addition to filtering based on the parameters below, you\ncan pass <trait_name>:<trait value id> to filter by any\ninstrument 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,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"","required":false,"allow_nil":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true},{"name":"name","full_name":"name","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"shallow","full_name":"shallow","description":"\nPass true to include trait values, or false to include the IDs of values\n(faster). Default: false.
\n","required":false,"allow_nil":false,"validator":"Must be true or false.","expected_type":"string","metadata":null,"show":true},{"name":"brand","full_name":"brand","description":"\nFilter based on a brand name
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"brand_id","full_name":"brand_id","description":"\nFilter based on a brand id
\n","required":false,"allow_nil":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true},{"name":"model_id","full_name":"model_id","description":"\nFilter based on a model id
\n","required":false,"allow_nil":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true},{"name":"submodel_id","full_name":"submodel_id","description":"\nFilter based on a submodel id
\n","required":false,"allow_nil":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true},{"name":"year","full_name":"year","description":"\nFilter based on a year
\n","required":false,"allow_nil":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true},{"name":"serial_number","full_name":"serial_number","description":"\nFilter based on a year provided by a serial number
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"approved","full_name":"approved","description":"","required":false,"allow_nil":false,"validator":"Must be true or false.","expected_type":"string","metadata":null,"show":true},{"name":"pending","full_name":"pending","description":"","required":false,"allow_nil":false,"validator":"Must be true or false.","expected_type":"string","metadata":null,"show":true}],"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 "],"metadata":null,"see":[],"headers":[]},{"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":"\nYou must provide a brand or brand_id and a model or model_id to retrieve\npossible traits. Ideally, your application should fetch\n/traits-with-variance
once the user has selected a brand,\nmodel and/or submodel. If you are using admin credentials to access the API\nyou may omit these parameters but you should consider caching the results\nwithin your application.
By default, this API returns a set of possibilities for every trait. If you\nonly need information about one trait, or a handful of traits, use the\nonly
parameter to improve performance (ex:\n?only=fingerboard_inlay,truss_rod
)
Pass true to include trait values, or false to include the IDs of values\n(faster). Default: false.
\n","required":false,"allow_nil":false,"validator":"Must be true or false.","expected_type":"string","metadata":null,"show":true},{"name":"only","full_name":"only","description":"\nPass a comma-separated list of trait keys to look up variance for only\nthose traits. Limiting your search can make the API much faster. For ex:\n&only=fingerboard_inlay,truss_rod
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"brand","full_name":"brand","description":"\nFilter based on a brand name
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"brand_id","full_name":"brand_id","description":"\nFilter based on a brand id
\n","required":false,"allow_nil":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true},{"name":"model","full_name":"model","description":"\nFilter based on a model name
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"model_id","full_name":"model_id","description":"\nFilter based on a model id
\n","required":false,"allow_nil":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true},{"name":"submodel","full_name":"submodel","description":"\nFilter based on a submodel name
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"submodel_id","full_name":"submodel_id","description":"\nFilter based on a submodel id
\n","required":false,"allow_nil":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true},{"name":"year","full_name":"year","description":"\nFilter based on a year
\n","required":false,"allow_nil":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true},{"name":"serial_number","full_name":"serial_number","description":"\nFilter based on a year provided by a serial number
\n","required":false,"allow_nil":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true},{"name":"approved","full_name":"approved","description":"","required":false,"allow_nil":false,"validator":"Must be true or false.","expected_type":"string","metadata":null,"show":true},{"name":"pending","full_name":"pending","description":"","required":false,"allow_nil":false,"validator":"Must be true or false.","expected_type":"string","metadata":null,"show":true}],"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":[]},{"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":"\nPass true to include trait values, or false to include the IDs of values\n(faster).
\n","required":false,"allow_nil":false,"validator":"Must be true or false.","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[]},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"brand_id","full_name":"brand_id","description":"","required":false,"allow_nil":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true},{"name":"model_id","full_name":"model_id","description":"","required":false,"allow_nil":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true},{"name":"submodel_id","full_name":"submodel_id","description":"","required":false,"allow_nil":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[]},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"brand_id","full_name":"brand_id","description":"","required":false,"allow_nil":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true},{"name":"model_id","full_name":"model_id","description":"","required":false,"allow_nil":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true},{"name":"submodel_id","full_name":"submodel_id","description":"","required":false,"allow_nil":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[]},{"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":[],"examples":[],"metadata":null,"see":[],"headers":[]}],"headers":[]},"model":{"doc_url":"/docs/1.0/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{\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,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"","required":false,"allow_nil":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true},{"name":"name","full_name":"name","description":"\n
List models with names matching the provided string.
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"name_like","full_name":"name_like","description":"\nList models with names matching, or similar to, the provided string.\nSlower, but useful for correcting user input.
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"brand","full_name":"brand","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"brand_id","full_name":"brand_id","description":"","required":false,"allow_nil":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true},{"name":"approved","full_name":"approved","description":"","required":false,"allow_nil":false,"validator":"Must be true or false.","expected_type":"string","metadata":null,"show":true},{"name":"pending","full_name":"pending","description":"","required":false,"allow_nil":false,"validator":"Must be true or false.","expected_type":"string","metadata":null,"show":true},{"name":"in_use","full_name":"in_use","description":"","required":false,"allow_nil":false,"validator":"Must be true or false.","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[]},{"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":[],"examples":[],"metadata":null,"see":[],"headers":[]},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"brand_id","full_name":"brand_id","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"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 "],"metadata":null,"see":[],"headers":[]},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"brand_id","full_name":"brand_id","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[]},{"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":[],"examples":[],"metadata":null,"see":[],"headers":[]}],"headers":[]},"serial_number_ranges":{"doc_url":"/docs/1.0/serial_number_ranges","api_url":"","name":"Serial Numbers","short_description":null,"full_description":"\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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"brand_id","full_name":"brand_id","description":"\nThe ID of the brand, if known. If you do not provide a brand ID or name,\nlookup may take longer.
\n","required":false,"allow_nil":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true},{"name":"brand_name","full_name":"brand_name","description":"\nThe name of the brand, if known. If you do not provide a brand ID or name,\nlookup may take longer.
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"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":[]}],"headers":[]},"submodel":{"doc_url":"/docs/1.0/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{\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,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"","required":false,"allow_nil":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true},{"name":"name","full_name":"name","description":"\n
List submodels with names matching the provided string.
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"name_like","full_name":"name_like","description":"\nList submodels with names matching, or similar to, the provided string.\nSlower, but useful for correcting user input.
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"model","full_name":"model","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"model_id","full_name":"model_id","description":"","required":false,"allow_nil":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true},{"name":"brand","full_name":"brand","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"brand_id","full_name":"brand_id","description":"","required":false,"allow_nil":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true},{"name":"approved","full_name":"approved","description":"","required":false,"allow_nil":false,"validator":"Must be true or false.","expected_type":"string","metadata":null,"show":true},{"name":"pending","full_name":"pending","description":"","required":false,"allow_nil":false,"validator":"Must be true or false.","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[]},{"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":[],"examples":[],"metadata":null,"see":[],"headers":[]},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"brand_id","full_name":"brand_id","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"model_id","full_name":"model_id","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"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 "],"metadata":null,"see":[],"headers":[]},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"brand_id","full_name":"brand_id","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"model_id","full_name":"model_id","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[]},{"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":[],"examples":[],"metadata":null,"see":[],"headers":[]}],"headers":[]},"trait_values":{"doc_url":"/docs/1.0/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,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"","required":false,"allow_nil":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true},{"name":"only","full_name":"only","description":"\nAn optional set of comma-separated trait column names. When you pass a\nspecific set of column names (eg:\n`?column_name=fingerboard_inlay,neck_binding`), the JSON response is an\nobject with an array of results for each requested column name.
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"in_use","full_name":"in_use","description":"","required":false,"allow_nil":false,"validator":"Must be true or false.","expected_type":"string","metadata":null,"show":true},{"name":"approved","full_name":"approved","description":"","required":false,"allow_nil":false,"validator":"Must be true or false.","expected_type":"string","metadata":null,"show":true},{"name":"pending","full_name":"pending","description":"","required":false,"allow_nil":false,"validator":"Must be true or false.","expected_type":"string","metadata":null,"show":true}],"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 "],"metadata":null,"see":[],"headers":[]},{"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":[],"examples":[],"metadata":null,"see":[],"headers":[]},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"column_value","full_name":"column_value","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"description","full_name":"description","description":"\nAn optional description
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"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 "],"metadata":null,"see":[],"headers":[]},{"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,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"column_value","full_name":"column_value","description":"","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true},{"name":"description","full_name":"description","description":"\nAn optional description
\n","required":false,"allow_nil":false,"validator":"Must be String","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[]},{"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":[],"examples":[],"metadata":null,"see":[],"headers":[]}],"headers":[]},"traits":{"doc_url":"/docs/1.0/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,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true},{"name":"per_page","full_name":"per_page","description":"","required":false,"allow_nil":false,"validator":"Must be Integer.","expected_type":"string","metadata":null,"show":true},{"name":"in_use","full_name":"in_use","description":"","required":false,"allow_nil":false,"validator":"Must be true or false.","expected_type":"string","metadata":null,"show":true},{"name":"approved","full_name":"approved","description":"","required":false,"allow_nil":false,"validator":"Must be true or false.","expected_type":"string","metadata":null,"show":true},{"name":"pending","full_name":"pending","description":"","required":false,"allow_nil":false,"validator":"Must be true or false.","expected_type":"string","metadata":null,"show":true}],"examples":[],"metadata":null,"see":[],"headers":[]},{"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":[],"examples":[],"metadata":null,"see":[],"headers":[]}],"headers":[]}}}}