Difference between revisions of "Add Customer"
From MyMobileWorkers API
(→Example JSON) |
|||
| Line 61: | Line 61: | ||
=== Example JSON === | === Example JSON === | ||
| − | |||
"customers":[ | "customers":[ | ||
{ | { | ||
| Line 71: | Line 70: | ||
} | } | ||
] | ] | ||
| − | |||
== Example curl request == | == Example curl request == | ||
Revision as of 10:41, 22 May 2013
Contents |
Summary
| Add Customer | ||
|---|---|---|
| URL | http://base_url/api_path/version/companies/company/customers/customer | |
| Type | POST | |
| Params: | api_key | required |
| file | required | |
| Response | JSON | |
The add customer action allows users to attach a customer to their company.
JSON Parameters
| Standard Fields | ||
|---|---|---|
| Field | Expected Data | Required |
| contact_name | varchar(45) * must be unique |
✓ |
| name | varchar(255) | |
| address_1 | varchar(45) | |
| address_2 | varchar(45) | |
| address_3 | varchar(45) | |
| address_4 | varchar(45) | |
| postcode | varchar(45) | |
| contact_number | varchar(45) | |
Example JSON
"customers":[
{
"name":"LeeLand",
"contact_name":"Mark Moose",
"address_1":"1 the street",
"postcode":"WA12 0JQ",
"contact_number":"01942295900"
}
]
Example curl request
curl -F validate_only=false -F update_existing=true -F api_key=YOURKEY -F file=@/Users/lee_orritt/Desktop/webAPICurling/create_customer.txt http://test.mymobileworkers.com:8080/api/1/companies/company/customers/customer
Responses
Example JSON
{"file":"tick.png","comment":"Transferred from API","created_at":"2013-05-20T14:42:37+00:00"}
