MyMobileWorkers API - User contributions [en-gb]

Update PO Number & Invoice Number

2017-01-03T14:51:15Z

Andy: /* Example curl request */

Provided you have the relevant job number, you can update both the PO Number & Invoice Number for said job. 
This, in turn, creates an entry in our jobs_invoicing table, which will contain the job_id, po_number & invoice_number.

== Summary ==
{| border="1" class="wikitable"

! Update PO Number & Invoice Number
! colspan="2" |
|-
! URL
| colspan="2" | https://:base_url/:api_path/:version/jobs//job/status/update?api_key=YOUR_KEY&&job_number=JOB_NUMBER&po_no=PO_NUMBER&invoice_number=INVOICE_NUMBER
|-
! Type
| colspan="2" | POST
|-
! Params:
| api_key || required
|-
!
| job_number || required
|-
!
| po_no || required
|-
!
| invoice_number || required
|-
! Response
| colspan="2" | JSON
|}

== Example curl request ==

curl -X POST "<nowiki>https://api.mymobileworkers.com:8181/api/1/jobs/job/status/update?api_key=APIKEY&job_number=JOB_NUM&po_no=PO_NUM&invoice_number=INVOICE_NUM</nowiki>"

Update PO Number & Invoice Number

2017-01-03T14:50:37Z

Andy: /* Summary */

Update PO Number & Invoice Number

2017-01-03T14:40:56Z

Andy: Created page with "== Summary == {| border="1" class="wikitable" ! Update PO Number & Invoice Number ! colspan="2" | |- ! URL | colspan="2" | https://:base_url/:api_path/:version/jobs//job/st..."

== Summary ==
{| border="1" class="wikitable"

! Update PO Number & Invoice Number
! colspan="2" |
|-
! URL
| colspan="2" | https://:base_url/:api_path/:version/jobs//job/status/update?api_key=YOUR_KEY&&job_number=JOB_NUMBER&po_number=PO_NUMBER&invoice_number=INVOICE_NUMBER
|-
! Type
| colspan="2" | POST
|-
! Params:
| api_key || required
|-
!
| job_number || required
|-
!
| po_number || required
|-
!
| invoice_number || required
|-
! Response
| colspan="2" | JSON
|}

Main Page

2017-01-03T14:30:55Z

Andy:

[[File:MMW_Logo_Stacked.png]]

Welcome to the MyMobileWorkers API documentation. This wiki is set up to guide developers through integrating with MyMobileWorkers.

The API uses JSON to transfer data. JSON is widely supported and most programming languages have built-in or comprehensive support with the use of a plugin.

You will need an API key, which can be obtained from the Settings section of the web portal.

=== Getting Started ===
*[[Connecting to the API]]
*[[Authentication|API Authentication]]
*[[Versioning]]
*[[Errors]]
*[[Datetime Formats]]
*[[List of Job Statuses]]
*[[Job Process Information]]
*Examples
**[[PHP]]
**[[Java]]

=== API Calls ===

*Jobs
** [[Get Job By Job Number]]
** [[Get Jobs By Status]]
** [[Get Job Updates Since]]
** [[Get Job Updates Between]]
** [[Get Photos Added Since]]
** [[Get Job Signatures]] (deprecated)
** [[Create Jobs]]
** [[Delete Job]]
** [[Delete Jobs]]
** [[Create Job Items]]
** [[Create Job Parts]]
** [[Get Job PDF]]
** [[Email Job PDF]]
** [[Setting the status of a job]]
** [[Update PO Number & Invoice Number]]

*Assets
** [[Create Assets]]
** [[Get Asset By Serial Number]]
** [[Get Assets Updated Since]]
** [[Get Assets Assigned To Customer]]
** [[Get Assets By Item Category]]
** [[Get Asset History By Serial Number]]
** [[Get Asset Statuses]]

*Items
** [[Create Items]]
** [[Get All Items]]
** [[Get Item By Name]]
** [[Delete Item By Name]]
** [[Create Items by External Id]]
** [[Get Item by External Id]]
** [[Delete Item By External Id]]

*Categories
** [[Create Category]]
** [[Delete Category By Name]]
** [[Delete Category By External Id]]
** [[Get Categories]]

*Catalogue
** [[Delete Entire Catalogue]]

*Mobile Users
** [[Get Mobile Users]]
** [[Get latest vehicle assignment by date and mobile user]]
** [[Get Mobile User Location]]
*Companies
** [[Get Company]]
*Customers
** [[Add Customer]]
** [[Update Customer Name]]
** [[Create Customer Contacts]]
*Routes
** [[Get jobs assigned to route]]
** [[Get total weight of route]]
** [[Get route limit]]
** [[Get all routes]]
*Attachments
**[[Create Job Attachment]]
**[[Delete Job Attachment]]
**[[Create Company Attachment]]
*Invoices
**[[Get Invoices Updated Since]]
**[[Get Invoices Updated Between]]
**[[Get Invoices Created Since]]
**[[Get Invoices Created Between]]

* ApiKey
**[[Check Key]]

Create Customer Sites

2016-03-17T10:15:51Z

Andy: /* JSON Contents */

== Summary ==

The create customer contacts action allows users to attach a contacts to a customer.
This method accepts an array of contacts to be added to the system.
A contact can be created via two different methods - either as multi-part form data with a JSON file attached and the API key as a parameter, or as JSON content on it's own, with the API key supplied within the JSON.

==== Multi Part Form Data ====
{| border="1" class="wikitable"

! Create Customer Contact
! colspan="2" |
|-
! URL
| colspan="2" | http://base_url/api_path/version/companies/company/customers/contacts
|-
! Type
| colspan="2" |POST
|-
! Params:
| api_key || required
|-
!
| file || required
|-

! Response
| colspan="2" | JSON
|}

==== JSON As Body ====
{| border="1" class="wikitable"
! Create Customer Contact - JSON
! colspan="2" |
|-
! URL
| colspan="2" | http://base_url/api_path/version/companies/company/customers/contacts
|-
! Type
| colspan="2" |POST
|-
!
| JSON {key, validate_only(optional), update_existing(optional), customers[]} ||| required
|-
! Response
| colspan="2" | JSON
|}

== JSON Contents ==

{| border="1" class="wikitable"
|+ The JSON file is passed in the post as the "file"
! colspan="3" | Standard Fields
|-
! Field
! Expected Data
! Required
|-
! customer
| {"name":"<customer name>"} *nested JSON object|| ✓
|-
! contact_name
| varchar(45) || ✓
|-
! external_id
| varchar(45) ||
|-
! address_1
| varchar(45) || ✓
|-
! address_2
| varchar(45) ||
|-
! address_3
| varchar(45) ||
|-
! address_4
| varchar(45) ||
|-
! postcode
| varchar(45) || ✓
|-
! contact_number
| varchar(45) || ✓
|-
! contact_email
| varchar(255) ||
|-
! sic_code
| int(11) ||
|-
|}

{| border="1" class="wikitable"
|+ Fields exclusive to JSON body format:
! colspan="3" | Standard Fields
|-
! Field
! Expected Data
! Required
|-
! key
| string - company api key || ✓
|-
! update_existing
| boolean ||
|-
! validate_only
| boolean ||
|-
|}

== Example Input ==

==== Multi Part Form Data ====

<source lang="java">
{
"customer_contacts":[
{
"external_id":"Contact1",
"contact_name":"test_contact",
"customer_id":{
"name":"test"
},
"address_1":"8 The Parks",
"address_2":"address 3",
"address_3":"address 4",
"address_4":"address 5",
"postcode":"WA12 0JQ",
"contact_number":"01234567891",
"sic_code":074313,
"contact_email":"stephen@mymobileworkers.com"
}
]
}
</source>

==== JSON As Body ====
<source lang="java">
{
"key":"testkey",
"validate_only":"false",
"update_existing":"true",
"customer_contacts":[
{
"external_id":"Contact1",
"contact_name":"test_contact",
"customer_id":{
"name":"test"
},
"address_1":"8 The Parks",
"address_2":"address 3",
"address_3":"address 4",
"address_4":"address 5",
"postcode":"WA12 0JQ",
"contact_number":"01234567891",
"sic_code":074313,
"contact_email":"stephen@mymobileworkers.com"
}
]
}
</source>

== Example Curl Requests ==

==== Multi Part Form Data ====

curl -F validate_only=false -F update_existing=true -F api_key=testkey -F file=@/Users/testuser/Desktop/webAPICurling/create_customer_contacts.txt http://live.mymobileworkers.com:8080/api/1/companies/company/customers/contacts

==== JSON As Body ====

curl -X POST -H "Content-Type: application/json" -d '{"key":"x4IOX6J3RcESDsN0kBAd","validate_only":"false","update_existing":"true","customer_contacts":[{"external_id":"ExtIdTest","contact_name":"Steve G","customer_id":{"name":"Above Average Construction Ltd."},"address_1":"Unit 5","address_2":"Random Industrial Estate","address_3":"Little Lane,"address_4":"Somewhere","postcode":"WA12 0JQ","contact_number":"01512143108","sic_code":2323525,"contact_email":"stephen@mymobileworkers.com"}]}' http://live.mymobileworkers.com:8080/api/1/companies/company/customers/contacts

== Responses ==

=== Example JSON ===

<source lang="java">
{
"successful":[
{
"contact_name":"test_contact"
}
],
"failed":[
{
"contact_name":"test_contact",
"errors":[
{
"error_code":"CCV002",
"error_message":"Address 1 cannot be null."
}
]
}
]
}
</source>

Create Customer Sites

2016-03-17T10:13:51Z

Andy: /* JSON As Body */

== Summary ==

The create customer contacts action allows users to attach a contacts to a customer.
This method accepts an array of contacts to be added to the system.
A contact can be created via two different methods - either as multi-part form data with a JSON file attached and the API key as a parameter, or as JSON content on it's own, with the API key supplied within the JSON.

==== Multi Part Form Data ====
{| border="1" class="wikitable"

! Create Customer Contact
! colspan="2" |
|-
! URL
| colspan="2" | http://base_url/api_path/version/companies/company/customers/contacts
|-
! Type
| colspan="2" |POST
|-
! Params:
| api_key || required
|-
!
| file || required
|-

! Response
| colspan="2" | JSON
|}

==== JSON As Body ====
{| border="1" class="wikitable"
! Create Customer Contact - JSON
! colspan="2" |
|-
! URL
| colspan="2" | http://base_url/api_path/version/companies/company/customers/contacts
|-
! Type
| colspan="2" |POST
|-
!
| JSON {key, validate_only(optional), update_existing(optional), customers[]} ||| required
|-
! Response
| colspan="2" | JSON
|}

== JSON Contents ==

{| border="1" class="wikitable"
|+ The JSON file is passed in the post as the "file"
! colspan="3" | Standard Fields
|-
! Field
! Expected Data
! Required
|-
! customer
| {"name":"<customer name>"} *nested JSON object|| ✓
|-
! contact_name
| varchar(45) || ✓
|-
! external_id
| varchar(45) ||
|-
! address_1
| varchar(45) || ✓
|-
! address_2
| varchar(45) ||
|-
! address_3
| varchar(45) ||
|-
! address_4
| varchar(45) ||
|-
! postcode
| varchar(45) || ✓
|-
! contact_number
| varchar(45) || ✓
|-
|}

{| border="1" class="wikitable"
|+ Fields exclusive to JSON body format:
! colspan="3" | Standard Fields
|-
! Field
! Expected Data
! Required
|-
! key
| string - company api key || ✓
|-
! update_existing
| boolean ||
|-
! validate_only
| boolean ||
|-
|}

== Example Input ==

==== Multi Part Form Data ====

<source lang="java">
{
"customer_contacts":[
{
"external_id":"Contact1",
"contact_name":"test_contact",
"customer_id":{
"name":"test"
},
"address_1":"8 The Parks",
"address_2":"address 3",
"address_3":"address 4",
"address_4":"address 5",
"postcode":"WA12 0JQ",
"contact_number":"01234567891",
"sic_code":074313,
"contact_email":"stephen@mymobileworkers.com"
}
]
}
</source>

==== JSON As Body ====
<source lang="java">
{
"key":"testkey",
"validate_only":"false",
"update_existing":"true",
"customer_contacts":[
{
"external_id":"Contact1",
"contact_name":"test_contact",
"customer_id":{
"name":"test"
},
"address_1":"8 The Parks",
"address_2":"address 3",
"address_3":"address 4",
"address_4":"address 5",
"postcode":"WA12 0JQ",
"contact_number":"01234567891",
"sic_code":074313,
"contact_email":"stephen@mymobileworkers.com"
}
]
}
</source>

== Example Curl Requests ==

==== Multi Part Form Data ====

curl -F validate_only=false -F update_existing=true -F api_key=testkey -F file=@/Users/testuser/Desktop/webAPICurling/create_customer_contacts.txt http://live.mymobileworkers.com:8080/api/1/companies/company/customers/contacts

==== JSON As Body ====

curl -X POST -H "Content-Type: application/json" -d '{"key":"x4IOX6J3RcESDsN0kBAd","validate_only":"false","update_existing":"true","customer_contacts":[{"external_id":"ExtIdTest","contact_name":"Steve G","customer_id":{"name":"Above Average Construction Ltd."},"address_1":"Unit 5","address_2":"Random Industrial Estate","address_3":"Little Lane,"address_4":"Somewhere","postcode":"WA12 0JQ","contact_number":"01512143108","sic_code":2323525,"contact_email":"stephen@mymobileworkers.com"}]}' http://live.mymobileworkers.com:8080/api/1/companies/company/customers/contacts

== Responses ==

=== Example JSON ===

<source lang="java">
{
"successful":[
{
"contact_name":"test_contact"
}
],
"failed":[
{
"contact_name":"test_contact",
"errors":[
{
"error_code":"CCV002",
"error_message":"Address 1 cannot be null."
}
]
}
]
}
</source>

Create Customer Sites

2016-03-17T10:13:27Z

Andy: /* Multi Part Form Data */

== Summary ==

The create customer contacts action allows users to attach a contacts to a customer.
This method accepts an array of contacts to be added to the system.
A contact can be created via two different methods - either as multi-part form data with a JSON file attached and the API key as a parameter, or as JSON content on it's own, with the API key supplied within the JSON.

==== Multi Part Form Data ====
{| border="1" class="wikitable"

! Create Customer Contact
! colspan="2" |
|-
! URL
| colspan="2" | http://base_url/api_path/version/companies/company/customers/contacts
|-
! Type
| colspan="2" |POST
|-
! Params:
| api_key || required
|-
!
| file || required
|-

! Response
| colspan="2" | JSON
|}

==== JSON As Body ====
{| border="1" class="wikitable"
! Create Customer Contact - JSON
! colspan="2" |
|-
! URL
| colspan="2" | http://base_url/api_path/version/companies/company/customers/contacts
|-
! Type
| colspan="2" |POST
|-
!
| JSON {key, validate_only(optional), update_existing(optional), customers[]} ||| required
|-
! Response
| colspan="2" | JSON
|}

== JSON Contents ==

{| border="1" class="wikitable"
|+ The JSON file is passed in the post as the "file"
! colspan="3" | Standard Fields
|-
! Field
! Expected Data
! Required
|-
! customer
| {"name":"<customer name>"} *nested JSON object|| ✓
|-
! contact_name
| varchar(45) || ✓
|-
! external_id
| varchar(45) ||
|-
! address_1
| varchar(45) || ✓
|-
! address_2
| varchar(45) ||
|-
! address_3
| varchar(45) ||
|-
! address_4
| varchar(45) ||
|-
! postcode
| varchar(45) || ✓
|-
! contact_number
| varchar(45) || ✓
|-
|}

{| border="1" class="wikitable"
|+ Fields exclusive to JSON body format:
! colspan="3" | Standard Fields
|-
! Field
! Expected Data
! Required
|-
! key
| string - company api key || ✓
|-
! update_existing
| boolean ||
|-
! validate_only
| boolean ||
|-
|}

== Example Input ==

==== Multi Part Form Data ====

<source lang="java">
{
"customer_contacts":[
{
"external_id":"Contact1",
"contact_name":"test_contact",
"customer_id":{
"name":"test"
},
"address_1":"8 The Parks",
"address_2":"address 3",
"address_3":"address 4",
"address_4":"address 5",
"postcode":"WA12 0JQ",
"contact_number":"01234567891",
"sic_code":074313,
"contact_email":"stephen@mymobileworkers.com"
}
]
}
</source>

==== JSON As Body ====
<source lang="java">
{
"key":"testkey",
"validate_only":"false",
"update_existing":"true",
"customer_contacts":[
{
"external_id":"Contact1",
"contact_name":"test_contact",
"customer_id":{
"name":"test"
},
"address_1":"8 The Parks",
"address_2":"address 3",
"address_3":"address 4",
"address_4":"address 5",
"postcode":"WA12 0JQ",
"contact_number":"01234567891"
}
]
}
</source>

== Example Curl Requests ==

==== Multi Part Form Data ====

curl -F validate_only=false -F update_existing=true -F api_key=testkey -F file=@/Users/testuser/Desktop/webAPICurling/create_customer_contacts.txt http://live.mymobileworkers.com:8080/api/1/companies/company/customers/contacts

==== JSON As Body ====

curl -X POST -H "Content-Type: application/json" -d '{"key":"x4IOX6J3RcESDsN0kBAd","validate_only":"false","update_existing":"true","customer_contacts":[{"external_id":"ExtIdTest","contact_name":"Steve G","customer_id":{"name":"Above Average Construction Ltd."},"address_1":"Unit 5","address_2":"Random Industrial Estate","address_3":"Little Lane,"address_4":"Somewhere","postcode":"WA12 0JQ","contact_number":"01512143108","sic_code":2323525,"contact_email":"stephen@mymobileworkers.com"}]}' http://live.mymobileworkers.com:8080/api/1/companies/company/customers/contacts

== Responses ==

=== Example JSON ===

<source lang="java">
{
"successful":[
{
"contact_name":"test_contact"
}
],
"failed":[
{
"contact_name":"test_contact",
"errors":[
{
"error_code":"CCV002",
"error_message":"Address 1 cannot be null."
}
]
}
]
}
</source>

Create Customer Sites

2016-03-17T10:11:29Z

Andy: /* JSON As Body */

== Summary ==

The create customer contacts action allows users to attach a contacts to a customer.
This method accepts an array of contacts to be added to the system.
A contact can be created via two different methods - either as multi-part form data with a JSON file attached and the API key as a parameter, or as JSON content on it's own, with the API key supplied within the JSON.

==== Multi Part Form Data ====
{| border="1" class="wikitable"

! Create Customer Contact
! colspan="2" |
|-
! URL
| colspan="2" | http://base_url/api_path/version/companies/company/customers/contacts
|-
! Type
| colspan="2" |POST
|-
! Params:
| api_key || required
|-
!
| file || required
|-

! Response
| colspan="2" | JSON
|}

==== JSON As Body ====
{| border="1" class="wikitable"
! Create Customer Contact - JSON
! colspan="2" |
|-
! URL
| colspan="2" | http://base_url/api_path/version/companies/company/customers/contacts
|-
! Type
| colspan="2" |POST
|-
!
| JSON {key, validate_only(optional), update_existing(optional), customers[]} ||| required
|-
! Response
| colspan="2" | JSON
|}

== JSON Contents ==

{| border="1" class="wikitable"
|+ The JSON file is passed in the post as the "file"
! colspan="3" | Standard Fields
|-
! Field
! Expected Data
! Required
|-
! customer
| {"name":"<customer name>"} *nested JSON object|| ✓
|-
! contact_name
| varchar(45) || ✓
|-
! external_id
| varchar(45) ||
|-
! address_1
| varchar(45) || ✓
|-
! address_2
| varchar(45) ||
|-
! address_3
| varchar(45) ||
|-
! address_4
| varchar(45) ||
|-
! postcode
| varchar(45) || ✓
|-
! contact_number
| varchar(45) || ✓
|-
|}

{| border="1" class="wikitable"
|+ Fields exclusive to JSON body format:
! colspan="3" | Standard Fields
|-
! Field
! Expected Data
! Required
|-
! key
| string - company api key || ✓
|-
! update_existing
| boolean ||
|-
! validate_only
| boolean ||
|-
|}

== Example Input ==

==== Multi Part Form Data ====

<source lang="java">
{
"customer_contacts":[
{
"external_id":"Contact1",
"contact_name":"test_contact",
"customer_id":{
"name":"test"
},
"address_1":"8 The Parks",
"address_2":"address 3",
"address_3":"address 4",
"address_4":"address 5",
"postcode":"WA12 0JQ",
"contact_number":"01234567891"
}
]
}
</source>

==== JSON As Body ====
<source lang="java">
{
"key":"testkey",
"validate_only":"false",
"update_existing":"true",
"customer_contacts":[
{
"external_id":"Contact1",
"contact_name":"test_contact",
"customer_id":{
"name":"test"
},
"address_1":"8 The Parks",
"address_2":"address 3",
"address_3":"address 4",
"address_4":"address 5",
"postcode":"WA12 0JQ",
"contact_number":"01234567891"
}
]
}
</source>

== Example Curl Requests ==

==== Multi Part Form Data ====

curl -F validate_only=false -F update_existing=true -F api_key=testkey -F file=@/Users/testuser/Desktop/webAPICurling/create_customer_contacts.txt http://live.mymobileworkers.com:8080/api/1/companies/company/customers/contacts

==== JSON As Body ====

curl -X POST -H "Content-Type: application/json" -d '{"key":"x4IOX6J3RcESDsN0kBAd","validate_only":"false","update_existing":"true","customer_contacts":[{"external_id":"ExtIdTest","contact_name":"Steve G","customer_id":{"name":"Above Average Construction Ltd."},"address_1":"Unit 5","address_2":"Random Industrial Estate","address_3":"Little Lane,"address_4":"Somewhere","postcode":"WA12 0JQ","contact_number":"01512143108","sic_code":2323525,"contact_email":"stephen@mymobileworkers.com"}]}' http://live.mymobileworkers.com:8080/api/1/companies/company/customers/contacts

== Responses ==

=== Example JSON ===

<source lang="java">
{
"successful":[
{
"contact_name":"test_contact"
}
],
"failed":[
{
"contact_name":"test_contact",
"errors":[
{
"error_code":"CCV002",
"error_message":"Address 1 cannot be null."
}
]
}
]
}
</source>

Add Customer

2016-03-17T09:58:34Z

Andy: /* JSON As Body */

== Summary ==

The add customer action allows users to attach a customer to their company.
This method accepts an array of customers to be added to the system.
A customer can be created via two different methods - either as multi-part form data with a JSON file attached and the API key as a parameter, or as JSON content on it's own, with the API key supplied within the JSON.

==== Multi Part Form Data ====
{| border="1" class="wikitable"

! Add Customer
! colspan="2" |
|-
! URL
| colspan="2" | http://base_url/api_path/version/companies/company/customers/customer
|-
! Type
| colspan="2" |POST
|-
! Params:
| api_key || required
|-
!
| file || required
|-

! Response
| colspan="2" | JSON
|}

==== JSON As Body ====
{| border="1" class="wikitable"
! Add Customer - JSON
! colspan="2" |
|-
! URL
| colspan="2" | http://base_url/api_path/version/companies/company/customers/customer
|-
! Type
| colspan="2" |POST
|-
!
| JSON {key, validate_only(optional), update_existing(optional), customers[]} ||| required
|-
! Response
| colspan="2" | JSON
|}

== JSON Contents ==

{| border="1" class="wikitable"
|+ The JSON file is passed in the post as the "file"
! colspan="3" | Standard Fields
|-
! Field
! Expected Data
! Required
|-
! contact_name
| varchar(45) ||
|-
! name
| varchar(255) * must be unique|| ✓
|-
! external_id
| varchar(45) ||
|-
! address_1
| varchar(45) ||
|-
! address_2
| varchar(45) ||
|-
! address_3
| varchar(45) ||
|-
! address_4
| varchar(45) ||
|-
! postcode
| varchar(45) ||
|-
! contact_number
| varchar(45) ||
|-
! contact_email
| varchar(255) ||
|-
! sic_code
| int(11) ||
|-
|}

{| border="1" class="wikitable"
|+ Fields exclusive to JSON body format:
! colspan="3" | Standard Fields
|-
! Field
! Expected Data
! Required
|-
! key
| string - company api key || ✓
|-
! update_existing
| boolean ||
|-
! validate_only
| boolean ||
|-
|}

== Example Input ==

==== Multi Part Form Data ====

<source lang="java">
"customers":[
{
"name":"LeeLand",
"external_id":"hello",
"contact_name":"Mark Moose",
"address_1":"1 the street",
"postcode":"WA12 0JQ",
"contact_number":"01942295900",
"sic_code":238495,
"contact_email":"stephen@mymobileworkers.com"
}
]
</source>

==== JSON As Body ====
<source lang="java">
{"key":"test", "validate_only":"true", "update_existing":"true", "customers":[
{
"name":"LeeLand",
"external_id":"hello",
"contact_name":"Mark Moose",
"address_1":"1 the street",
"postcode":"WA12 0JQ",
"contact_number":"01942295900"
"sic_code":238495,
"contact_email":"stephen@mymobileworkers.com"
}
]
}
</source>

== Example Curl Requests ==

==== Multi Part Form Data ====

curl -F validate_only=false -F update_existing=true -F api_key=YOURKEY -F file=@/Users/lee_orritt/Desktop/webAPICurling/create_customer.txt http://live.mymobileworkers.com:8080/api/1/companies/company/customers/customer

==== JSON As Body ====

curl -X POST -H "Content-Type: application/json" -d '{"key":"APIKEYGOESHERE", "validate_only":"true", "update_existing":"true", "customers":[{"name":"Above Average Construction Ltd.","external_id":"TestID234","contact_name":"Steve G","address_1":"123 The Street","postcode":"WA12 0JQ","contact_number":"01512143108","sic_code":238495,"contact_email":"stephen@mymobileworkers.com"}]}' http://live.mymobileworkers.com:8080/api/1/companies/company/customers/customer

== Responses ==

=== Example JSON ===

<source lang="java">
{
"file":"tick.png",
"comment":"Transferred from API",
"created_at":"2013-05-20T14:42:37+00:00"
}
</source>

Add Customer

2016-03-17T09:55:02Z

Andy: /* JSON Contents */

== Summary ==

The add customer action allows users to attach a customer to their company.
This method accepts an array of customers to be added to the system.
A customer can be created via two different methods - either as multi-part form data with a JSON file attached and the API key as a parameter, or as JSON content on it's own, with the API key supplied within the JSON.

==== Multi Part Form Data ====
{| border="1" class="wikitable"

! Add Customer
! colspan="2" |
|-
! URL
| colspan="2" | http://base_url/api_path/version/companies/company/customers/customer
|-
! Type
| colspan="2" |POST
|-
! Params:
| api_key || required
|-
!
| file || required
|-

! Response
| colspan="2" | JSON
|}

==== JSON As Body ====
{| border="1" class="wikitable"
! Add Customer - JSON
! colspan="2" |
|-
! URL
| colspan="2" | http://base_url/api_path/version/companies/company/customers/customer
|-
! Type
| colspan="2" |POST
|-
!
| JSON {key, validate_only(optional), update_existing(optional), customers[]} ||| required
|-
! Response
| colspan="2" | JSON
|}

== JSON Contents ==

{| border="1" class="wikitable"
|+ The JSON file is passed in the post as the "file"
! colspan="3" | Standard Fields
|-
! Field
! Expected Data
! Required
|-
! contact_name
| varchar(45) ||
|-
! name
| varchar(255) * must be unique|| ✓
|-
! external_id
| varchar(45) ||
|-
! address_1
| varchar(45) ||
|-
! address_2
| varchar(45) ||
|-
! address_3
| varchar(45) ||
|-
! address_4
| varchar(45) ||
|-
! postcode
| varchar(45) ||
|-
! contact_number
| varchar(45) ||
|-
! contact_email
| varchar(255) ||
|-
! sic_code
| int(11) ||
|-
|}

{| border="1" class="wikitable"
|+ Fields exclusive to JSON body format:
! colspan="3" | Standard Fields
|-
! Field
! Expected Data
! Required
|-
! key
| string - company api key || ✓
|-
! update_existing
| boolean ||
|-
! validate_only
| boolean ||
|-
|}

== Example Input ==

==== Multi Part Form Data ====

<source lang="java">
"customers":[
{
"name":"LeeLand",
"external_id":"hello",
"contact_name":"Mark Moose",
"address_1":"1 the street",
"postcode":"WA12 0JQ",
"contact_number":"01942295900",
"sic_code":238495,
"contact_email":"stephen@mymobileworkers.com"
}
]
</source>

==== JSON As Body ====
<source lang="java">
{"key":"test", "validate_only":"true", "update_existing":"true", "customers":[
{
"name":"LeeLand",
"external_id":"hello",
"contact_name":"Mark Moose",
"address_1":"1 the street",
"postcode":"WA12 0JQ",
"contact_number":"01942295900"
"sic_code":238495,
"contact_email":"stephen@mymobileworkers.com"
}
]
}
</source>

== Example Curl Requests ==

==== Multi Part Form Data ====

curl -F validate_only=false -F update_existing=true -F api_key=YOURKEY -F file=@/Users/lee_orritt/Desktop/webAPICurling/create_customer.txt http://live.mymobileworkers.com:8080/api/1/companies/company/customers/customer

==== JSON As Body ====

curl -X POST -H "Content-Type: application/json" -d '{"key":"darrenwebapi", "validate_only":"false", "update_existing":true,"customers":[{"name":"LeeLand","external_id":"hello","contact_name":"testName","address_1":"1 the street","postcode":"WA12 0JQ","contact_number":"01942295900"}]}' http://live.mymobileworkers.com:8080/api/1/companies/company/customers/customer

== Responses ==

=== Example JSON ===

<source lang="java">
{
"file":"tick.png",
"comment":"Transferred from API",
"created_at":"2013-05-20T14:42:37+00:00"
}
</source>

Add Customer

2016-03-17T09:51:08Z

Andy: /* JSON As Body */

== Summary ==

The add customer action allows users to attach a customer to their company.
This method accepts an array of customers to be added to the system.
A customer can be created via two different methods - either as multi-part form data with a JSON file attached and the API key as a parameter, or as JSON content on it's own, with the API key supplied within the JSON.

==== Multi Part Form Data ====
{| border="1" class="wikitable"

! Add Customer
! colspan="2" |
|-
! URL
| colspan="2" | http://base_url/api_path/version/companies/company/customers/customer
|-
! Type
| colspan="2" |POST
|-
! Params:
| api_key || required
|-
!
| file || required
|-

! Response
| colspan="2" | JSON
|}

==== JSON As Body ====
{| border="1" class="wikitable"
! Add Customer - JSON
! colspan="2" |
|-
! URL
| colspan="2" | http://base_url/api_path/version/companies/company/customers/customer
|-
! Type
| colspan="2" |POST
|-
!
| JSON {key, validate_only(optional), update_existing(optional), customers[]} ||| required
|-
! Response
| colspan="2" | JSON
|}

== JSON Contents ==

{| border="1" class="wikitable"
|+ The JSON file is passed in the post as the "file"
! colspan="3" | Standard Fields
|-
! Field
! Expected Data
! Required
|-
! contact_name
| varchar(45) ||
|-
! name
| varchar(255) * must be unique|| ✓
|-
! external_id
| varchar(45) ||
|-
! address_1
| varchar(45) ||
|-
! address_2
| varchar(45) ||
|-
! address_3
| varchar(45) ||
|-
! address_4
| varchar(45) ||
|-
! postcode
| varchar(45) ||
|-
! contact_number
| varchar(45) ||
|-
|}

{| border="1" class="wikitable"
|+ Fields exclusive to JSON body format:
! colspan="3" | Standard Fields
|-
! Field
! Expected Data
! Required
|-
! key
| string - company api key || ✓
|-
! update_existing
| boolean ||
|-
! validate_only
| boolean ||
|-
|}

== Example Input ==

==== Multi Part Form Data ====

<source lang="java">
"customers":[
{
"name":"LeeLand",
"external_id":"hello",
"contact_name":"Mark Moose",
"address_1":"1 the street",
"postcode":"WA12 0JQ",
"contact_number":"01942295900",
"sic_code":238495,
"contact_email":"stephen@mymobileworkers.com"
}
]
</source>

==== JSON As Body ====
<source lang="java">
{"key":"test", "validate_only":"true", "update_existing":"true", "customers":[
{
"name":"LeeLand",
"external_id":"hello",
"contact_name":"Mark Moose",
"address_1":"1 the street",
"postcode":"WA12 0JQ",
"contact_number":"01942295900"
"sic_code":238495,
"contact_email":"stephen@mymobileworkers.com"
}
]
}
</source>

== Example Curl Requests ==

==== Multi Part Form Data ====

curl -F validate_only=false -F update_existing=true -F api_key=YOURKEY -F file=@/Users/lee_orritt/Desktop/webAPICurling/create_customer.txt http://live.mymobileworkers.com:8080/api/1/companies/company/customers/customer

==== JSON As Body ====

curl -X POST -H "Content-Type: application/json" -d '{"key":"darrenwebapi", "validate_only":"false", "update_existing":true,"customers":[{"name":"LeeLand","external_id":"hello","contact_name":"testName","address_1":"1 the street","postcode":"WA12 0JQ","contact_number":"01942295900"}]}' http://live.mymobileworkers.com:8080/api/1/companies/company/customers/customer

== Responses ==

=== Example JSON ===

<source lang="java">
{
"file":"tick.png",
"comment":"Transferred from API",
"created_at":"2013-05-20T14:42:37+00:00"
}
</source>

Add Customer

2016-03-17T09:50:26Z

Andy: /* Multi Part Form Data */

== Summary ==

The add customer action allows users to attach a customer to their company.
This method accepts an array of customers to be added to the system.
A customer can be created via two different methods - either as multi-part form data with a JSON file attached and the API key as a parameter, or as JSON content on it's own, with the API key supplied within the JSON.

==== Multi Part Form Data ====
{| border="1" class="wikitable"

! Add Customer
! colspan="2" |
|-
! URL
| colspan="2" | http://base_url/api_path/version/companies/company/customers/customer
|-
! Type
| colspan="2" |POST
|-
! Params:
| api_key || required
|-
!
| file || required
|-

! Response
| colspan="2" | JSON
|}

==== JSON As Body ====
{| border="1" class="wikitable"
! Add Customer - JSON
! colspan="2" |
|-
! URL
| colspan="2" | http://base_url/api_path/version/companies/company/customers/customer
|-
! Type
| colspan="2" |POST
|-
!
| JSON {key, validate_only(optional), update_existing(optional), customers[]} ||| required
|-
! Response
| colspan="2" | JSON
|}

== JSON Contents ==

{| border="1" class="wikitable"
|+ The JSON file is passed in the post as the "file"
! colspan="3" | Standard Fields
|-
! Field
! Expected Data
! Required
|-
! contact_name
| varchar(45) ||
|-
! name
| varchar(255) * must be unique|| ✓
|-
! external_id
| varchar(45) ||
|-
! address_1
| varchar(45) ||
|-
! address_2
| varchar(45) ||
|-
! address_3
| varchar(45) ||
|-
! address_4
| varchar(45) ||
|-
! postcode
| varchar(45) ||
|-
! contact_number
| varchar(45) ||
|-
|}

{| border="1" class="wikitable"
|+ Fields exclusive to JSON body format:
! colspan="3" | Standard Fields
|-
! Field
! Expected Data
! Required
|-
! key
| string - company api key || ✓
|-
! update_existing
| boolean ||
|-
! validate_only
| boolean ||
|-
|}

== Example Input ==

==== Multi Part Form Data ====

<source lang="java">
"customers":[
{
"name":"LeeLand",
"external_id":"hello",
"contact_name":"Mark Moose",
"address_1":"1 the street",
"postcode":"WA12 0JQ",
"contact_number":"01942295900",
"sic_code":238495,
"contact_email":"stephen@mymobileworkers.com"
}
]
</source>

==== JSON As Body ====
<source lang="java">
{"key":"test", "validate_only":"true", "update_existing":"true", "customers":[
{
"name":"LeeLand",
"external_id":"hello",
"contact_name":"Mark Moose",
"address_1":"1 the street",
"postcode":"WA12 0JQ",
"contact_number":"01942295900"
}
]
}
</source>

== Example Curl Requests ==

==== Multi Part Form Data ====

curl -F validate_only=false -F update_existing=true -F api_key=YOURKEY -F file=@/Users/lee_orritt/Desktop/webAPICurling/create_customer.txt http://live.mymobileworkers.com:8080/api/1/companies/company/customers/customer

==== JSON As Body ====

curl -X POST -H "Content-Type: application/json" -d '{"key":"darrenwebapi", "validate_only":"false", "update_existing":true,"customers":[{"name":"LeeLand","external_id":"hello","contact_name":"testName","address_1":"1 the street","postcode":"WA12 0JQ","contact_number":"01942295900"}]}' http://live.mymobileworkers.com:8080/api/1/companies/company/customers/customer

== Responses ==

=== Example JSON ===

<source lang="java">
{
"file":"tick.png",
"comment":"Transferred from API",
"created_at":"2013-05-20T14:42:37+00:00"
}
</source>