{"name":"Customer api","organization":{"key":"platforminitiative"},"application":{"key":"customer-api"},"namespace":"platform.ibm.com.customer.api.v0","version":"0.0.1-dev","info":{"license":{"name":"MIT","url":"http://opensource.org/licenses/MIT"},"contact":{"name":"IBM"}},"headers":[],"imports":[],"enums":[],"interfaces":[],"unions":[],"models":[{"name":"customer","plural":"customers","fields":[{"name":"financialAccountNumber","type":"uuid","required":true,"attributes":[],"annotations":[],"description":"financialAccountNumber"},{"name":"customerName","type":"string","required":true,"attributes":[],"annotations":[],"description":"customerName"},{"name":"branchNumber","type":"string","required":true,"attributes":[],"annotations":[],"description":"branchNumber"},{"name":"address1","type":"string","required":false,"attributes":[],"annotations":[],"description":"address1"},{"name":"address2","type":"string","required":false,"attributes":[],"annotations":[],"description":"address2"},{"name":"city","type":"string","required":false,"attributes":[],"annotations":[],"description":"city"},{"name":"state","type":"string","required":false,"attributes":[],"annotations":[],"description":"state"},{"name":"zip","type":"string","required":false,"attributes":[],"annotations":[],"description":"zip"}],"attributes":[],"interfaces":[],"description":"Customer"},{"name":"customer_create_form","plural":"customer_create_forms","fields":[{"name":"branchNumber","type":"string","required":true,"attributes":[],"annotations":[],"description":"Branch Number"},{"name":"customerName","type":"string","required":true,"attributes":[],"annotations":[],"description":"customer Name"},{"name":"email","type":"string","required":true,"attributes":[],"annotations":[],"description":"Email"},{"name":"address1","type":"string","required":true,"attributes":[],"annotations":[],"description":"Address1"},{"name":"address2","type":"string","required":false,"attributes":[],"annotations":[],"description":"Address2"},{"name":"city","type":"string","required":true,"attributes":[],"annotations":[],"description":"City"},{"name":"state","type":"string","required":true,"attributes":[],"annotations":[],"description":"State"},{"name":"zip","type":"string","required":true,"attributes":[],"annotations":[],"description":"Zip"}],"attributes":[],"interfaces":[],"description":"customer Creation Form"},{"name":"customer_summary","plural":"customer_summaries","fields":[{"name":"financialAccountNumber","type":"uuid","required":true,"attributes":[],"annotations":[],"description":"Financial Account Number"},{"name":"customerName","type":"string","required":true,"attributes":[],"annotations":[],"description":"Customer Name"}],"attributes":[],"interfaces":[],"description":"Customer Summery"},{"name":"customer_update_form","plural":"customer_update_forms","fields":[{"name":"financialAccountNumber","type":"string","required":true,"attributes":[],"annotations":[],"description":"Financial Account Number"},{"name":"customerName","type":"string","required":true,"attributes":[],"annotations":[],"description":"Customer Name"},{"name":"email","type":"string","required":true,"attributes":[],"annotations":[],"description":"Email"},{"name":"address1","type":"string","required":true,"attributes":[],"annotations":[],"description":"Address1"},{"name":"address2","type":"string","required":true,"attributes":[],"annotations":[],"description":"Address2"},{"name":"city","type":"string","required":true,"attributes":[],"annotations":[],"description":"City"},{"name":"state","type":"string","required":true,"attributes":[],"annotations":[],"description":"State"},{"name":"zip","type":"string","required":true,"attributes":[],"annotations":[],"description":"Zip"}],"attributes":[],"interfaces":[],"description":"customer Update Form"},{"name":"error","plural":"errors","fields":[{"name":"code","type":"string","required":true,"attributes":[],"annotations":[],"description":"Machine readable code for this specific error message"},{"name":"description","type":"string","required":true,"attributes":[],"annotations":[],"description":"Description of the error"}],"attributes":[],"interfaces":[]}],"resources":[{"type":"customer","plural":"customers","operations":[{"method":"GET","path":"/customers/customers","parameters":[{"name":"financialAccountNumber","type":"uuid","location":"Query","required":false,"description":"Find customer with this financialAccountNumber. Exact match"},{"name":"email","type":"string","location":"Query","required":false,"description":"Find user with this email address. Case in-sensitive. Exact match"},{"name":"customerName","type":"string","location":"Query","required":false,"description":"Find user with the specified nickname. For users that register via GitHub, this will be their GitHub username. Case in-sensitive. Exact match"}],"responses":[{"code":{"integer":{"value":200}},"type":"[customer]","attributes":[]},{"code":{"integer":{"value":404}},"type":"[error]","attributes":[]},{"code":{"integer":{"value":500}},"type":"[error]","attributes":[]}],"attributes":[],"description":"Search for a specific customer. You must specify at least 1 parameter - either a guid, email or token - and will receive back either 0 or 1 users."},{"method":"GET","path":"/customers/:customerName","parameters":[{"name":"customerName","type":"string","location":"Path","required":true}],"responses":[{"code":{"integer":{"value":200}},"type":"customer","attributes":[]},{"code":{"integer":{"value":404}},"type":"[error]","attributes":[]},{"code":{"integer":{"value":500}},"type":"[error]","attributes":[]}],"attributes":[],"description":"Returns information about the user with this financialAccountNumber."},{"method":"POST","path":"/customers/customers","parameters":[],"responses":[{"code":{"integer":{"value":200}},"type":"customer","attributes":[]},{"code":{"integer":{"value":500}},"type":"[error]","attributes":[]}],"attributes":[],"description":"Create a new customer.","body":{"type":"customer_create_form","attributes":[]}},{"method":"PUT","path":"/customers/:customerName","parameters":[{"name":"customerName","type":"string","location":"Path","required":true}],"responses":[{"code":{"integer":{"value":200}},"type":"customer","attributes":[]},{"code":{"integer":{"value":404}},"type":"[error]","attributes":[]},{"code":{"integer":{"value":500}},"type":"[error]","attributes":[]}],"attributes":[],"description":"Updates information about the customer with the specified financialAccountNumber.","body":{"type":"customer_update_form","attributes":[]}}],"attributes":[],"path":"/customers"}],"attributes":[],"annotations":[],"apidoc":{"version":"0.0.1-dev"},"base_url":"https://api.apibuilder.io","description":"Customer API documentation providing details for REST APIs"}