{"docs":{"name":"Bloom","info":"\n\u003cp\u003eAnother API description\u003c/p\u003e\n","copyright":null,"doc_url":"/developers/1","api_url":"/api","resources":[{"doc_url":"/developers/1/agents","id":"agents","api_url":"/api","name":"Agents","short_description":null,"full_description":null,"version":"1","formats":null,"metadata":null,"methods":[{"doc_url":"/developers/1/agents/index","name":"index","apis":[{"api_url":"/api/v1/partners/:api_token/agents","http_method":"GET","short_description":"Show a list of agents belonging to this partner","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eReturn a list of agents created by this partner, sorted by newest first.\u003c/p\u003e\n","errors":[],"params":[],"returns":[],"examples":["https://www.bloomremit.net/api/v1/partners/:api_token/agents\n"],"metadata":null,"see":[],"headers":[{"name":"X-API-SECRET","description":"API secret of your organization","options":{}}],"show":true},{"doc_url":"/developers/1/agents/show","name":"show","apis":[{"api_url":"/api/v1/partners/:api_token/agents/:id","http_method":"GET","short_description":"Show an agent belonging to this partner","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[],"examples":["https://www.bloomremit.net/api/v1/partners/:api_token/agents/:id\n"],"metadata":null,"see":[],"headers":[{"name":"X-API-SECRET","description":"API secret of your organization","options":{}}],"show":true},{"doc_url":"/developers/1/agents/create","name":"create","apis":[{"api_url":"/api/v1/partners/:api_token/agents","http_method":"POST","short_description":"Create a new agent under this partner","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eCreate a new agent account under this partner. Take note of the ID parameter in the returned Agent hash, it is how you will access this same agent later on.\u003c/p\u003e\n","errors":[],"params":[{"name":"agent","full_name":"agent","description":"\n\u003cp\u003eAgent Information\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"agent[name]","description":"\n\u003cp\u003eName of the Agent\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["https://www.bloomremit.net/api/v1/partners/:api_token/agents\n\n{\n  \"agent\": {\n    \"name\": \"Seoul Branch\"\n  }\n}\n\n"],"metadata":null,"see":[],"headers":[{"name":"X-API-SECRET","description":"API secret of your organization","options":{}}],"show":true},{"doc_url":"/developers/1/agents/update","name":"update","apis":[{"api_url":"/api/v1/partners/:api_token/agents/:id","http_method":"PUT","short_description":"Update the attributes of an agent belonging to this partner","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eUpdate agent information.\u003c/p\u003e\n","errors":[],"params":[{"name":"agent","full_name":"agent","description":"\n\u003cp\u003eAgent Information\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"name","full_name":"agent[name]","description":"\n\u003cp\u003eName of the Agent\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":["https://www.bloomremit.net/api/v1/partners/:api_token/agents\n\n{\n  \"agent\": {\n    \"name\": \"Incheon Branch\"\n  }\n}\n\n"],"metadata":null,"see":[],"headers":[{"name":"X-API-SECRET","description":"API secret of your organization","options":{}}],"show":true},{"doc_url":"/developers/1/agents/destroy","name":"destroy","apis":[{"api_url":"/api/v1/partners/:api_token/agents/:id","http_method":"DELETE","short_description":"Delete an agent belonging to this VENDOR partner","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eDelete an agent. This will not work if the agent has any users associated with it.\u003c/p\u003e\n","errors":[],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[{"name":"X-API-SECRET","description":"API secret of your organization","options":{}}],"show":true}],"headers":null,"deprecated":null}]}}