Difference between revisions of "Update Custom List"

From MyMobileWorkers API
Jump to: navigation, search
(→‎JSON As Body)
Line 25: Line 25:
 
|}
 
|}
  
 +
 +
{| border="1" class="wikitable"
 +
|+ Gas Safe (nested) object:
 +
 +
! colspan="3" | Standard Fields
 +
|-
 +
! Field
 +
! Expected Data
 +
! Required
 +
|-
 +
! owner_title
 +
| varchar(45) ||
 +
|-
 +
! owner_name
 +
| varchar(45) || ✓
 +
|-
 +
! owner_address_1
 +
| varchar(45) || ✓
 +
|-
 +
! owner_address_2
 +
| varchar(45) ||
 +
|-
 +
! owner_address_3
 +
| varchar(45) ||
 +
|-
 +
! owner_address_4
 +
| varchar(45) ||
 +
|-
 +
! owner_postcode
 +
| varchar(45) || ✓
 +
|- 
 +
! owner_contact_number
 +
| varchar(45) (7, 10 or 11 digits) ||
 +
|-
 +
! owner_email
 +
| varchar(255) ||
 +
|-
 +
! customer_email
 +
| varchar(255) ||
 +
|-
 +
|}
  
 
==== JSON As Body ====
 
==== JSON As Body ====

Revision as of 14:41, 27 July 2017

Contents

Summary

The Update Custom List API call allows an existing list to be updated with a new name, description and list items by giving the list key within the request. When updating the list, it will delete any existing items in the custom list and replace with the items provided in the response.

A custom list can be updated via two different methods - either as multi-part form data, or as JSON content on its own, with the API key supplied within the JSON.

Multi Part Form Data

Update Customer Name
URL http://base_url/api_path/version/lists/edit
Type POST
Params: key required
Response JSON


Gas Safe (nested) object:
Standard Fields
Field Expected Data Required
owner_title varchar(45)
owner_name varchar(45) ✓
owner_address_1 varchar(45) ✓
owner_address_2 varchar(45)
owner_address_3 varchar(45)
owner_address_4 varchar(45)
owner_postcode varchar(45) ✓
owner_contact_number varchar(45) (7, 10 or 11 digits)
owner_email varchar(255)
customer_email varchar(255)

JSON As Body

Create Job - JSON
URL http://base_url/api_path/version/list/edit
Type POST
key required
branch_name optional
list (object) required
{list object} name required
{list object} description optional
{list object} list_key required
{list object} items required
Response JSON

JSON Contents 

{
   "key":"APIKEY",
   "branch_name":"BranchA",
   "list":{  
      "name":"Delivery sites",
      "description":"A list of delivery sites in the area",
      "list_key":"delivery_site1",
      "list_items":[  
         {  
            "name":"Aldcliffe Site",
            "notes":"small",
            "order_position":5
         },
         {  
            "name":"Bond Estate",
            "notes":"medium",
            "order_position":6
         }
      ]
   }
}

Example Curl Request

Multi Part Form Data

curl -F api_key=YOUR_KEY http://api.mymobileworkers.com:8080/api/1/lists/edit

JSON As Body

curl -X POST -H "Content-Type: application/json" -d '{"key":"YOUR_KEY"}' http://api.mymobileworkers.com:8080/api/1/lists/edit

Responses

Successful 

{
  "successful": {
    "list_name": "Delivery sites",
    "branch_name": null
  }
}

Unsuccessful 

{"error_code": "LIS002", "error_message": "List not found."}
{"error_code": "LIS001", "error_message": "List key not provided. Please include in request."}
{ "error_code": "LIS004", "error_message": "No items were provided."}
Retrieved from ‘https://docs.mymobileworkers.com/index.php?title=Update_Custom_List&oldid=1012’
Personal tools
Namespaces

Variants
Actions
Navigation
Toolbox