Difference between revisions of "Create Company Attachment Folders"

From MyMobileWorkers API
Jump to: navigation, search
(Created page with " == Summary == A company folder 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...")
 
(→‎JSON As Body)
 
(17 intermediate revisions by one user not shown)
Line 8: Line 8:
 
{| border="1" class="wikitable"
 
{| border="1" class="wikitable"
  
−
! Create Job item
+
! Create Item
 
! colspan="2" |  
 
! colspan="2" |  
 
|-
 
|-
 
!  URL
 
!  URL
−
| colspan="2" | http://:base_url/:api_path/:version/companies/company/attachment_folders
+
| colspan="2" | http://base_url/api_path/version/companies/company/attachment_folders
 
|-
 
|-
 
! Type
 
! Type
Line 21: Line 21:
 
|-
 
|-
 
!  
 
!  
−
| validate_only || required  
+
| file || required
 
|-
 
|-
 
!  
 
!  
−
| file || required
+
| update_existing || optional (default = false)
 
|-
 
|-
 
!  
 
!  
−
| job_number || required
+
| validate_only || optional (default = false)
 
|-
 
|-
 
! Response
 
! Response
Line 39: Line 39:
 
|-
 
|-
 
!  URL
 
!  URL
−
| colspan="2" | http://:base_url/:api_path/:version/jobs/job/items
+
| colspan="2" | http://:base_url/:api_path/:version/companies/company/attachment_folders
 
|-
 
|-
 
! Type
 
! Type
Line 45: Line 45:
 
|-
 
|-
 
!  
 
!  
−
| JSON <br /> {key, job_number, validate_only(optional), update_existing(optional), replace_existing(optional), items[]}  ||| required     
+
| JSON <br /> {key, validate_only(optional), update_existing(optional), folders[]}  ||| required     
 
|-
 
|-
 
! Response
 
! Response
Line 59: Line 59:
 
! Required
 
! Required
 
|-
 
|-
−
! name OR external_id
+
! name
 
| varchar(45) || &#10003;
 
| varchar(45) || &#10003;
 
|-
 
|-
−
! type
+
! order_position
−
| "C","D" <br /><span style="font-size:80%; font-weight:normal">* Collect/Deliver</span>|| &#10003;
+
−
|-
+
−
! expected_quantity
+
 
| int(4) || &#10003;
 
| int(4) || &#10003;
 
|-
 
|-
−
! other
+
! folder_key
−
| varchar(45) ||
+
| varchar(45) || &#10003;
 
|-
 
|-
 
! notes
 
! notes
−
| varchar(45) ||
+
| varchar(45) ||  
−
|-
+
−
! barcodes
+
−
| varchar(45) ||
+
 
|-
 
|-
 
|}
 
|}
Line 89: Line 83:
 
! key
 
! key
 
| string - company api key || &#10003;
 
| string - company api key || &#10003;
−
|-
 
−
! job_number
 
−
| string - job number || &#10003;
 
 
|-
 
|-
 
! validate_only
 
! validate_only
Line 97: Line 88:
 
|-
 
|-
 
! update_existing
 
! update_existing
−
| boolean ||
 
−
|-
 
−
! replace_existing
 
 
| boolean ||
 
| boolean ||
 
|-  
 
|-  
Line 109: Line 97:
  
 
<source lang="java">
 
<source lang="java">
−
{"items":[{
+
{"folders":[
−
"type":"C",
+
      {
−
"expected_quantity":"4",
+
        "name":"folder_test",
−
"other":"test",
+
        "notes":"testing",
−
"notes":"exampleNotes",
+
        "order_position":1,
−
"name":"darrenItem245",
+
        "folder_key":"folder_key"
−
"barcodes":"barcode,barcode1"
+
      }
−
}]}
+
  ]}
 
</source>
 
</source>
  
Line 123: Line 111:
 
<source lang="java">
 
<source lang="java">
 
{
 
{
−
   "key":"darrenwebapi",
+
   "key":"api_key",
−
   "job_number":"123",
+
   "validate_only":"false",
−
   "items":[
+
   "update_existing":true,
 +
  "folders":[
 
       {
 
       {
−
        "type":"C",
+
        "name":"folder_test",
−
        "expected_quantity":"4",
+
        "notes":"testing",
−
        "other":"test",
+
        "order_position":1,
−
        "notes":"exampleNotes",
+
        "folder_key":"folder_key"
−
        "name":"darrenItem",
+
−
        "barcodes":"barcode,barcode1"
+
 
       }
 
       }
 
   ]
 
   ]
 
}
 
}
 +
 
</source>
 
</source>
  
Line 143: Line 131:
  
 
<source lang="php">
 
<source lang="php">
−
curl -F validate_only=false -F update_existing=true -F api_key=[YOUR_API_KEY] -F job_number=123 -F file=@/Users/darrenatherton/Desktop/webAPICurling/create_job_item_stage.txt http://api.mymobileworkers.com:8080/api/1/jobs/job/items
+
curl -F validate_only=false -F update_existing=true -F api_key=[YOUR_API_KEY] -F file=@/Users/darrenatherton/Desktop/webAPICurling/create_attachment_folders.txt http://api.mymobileworkers.com:8080/api/1/companies/company/attachment_folders
 
</source>
 
</source>
  
Line 149: Line 137:
  
 
<source lang="php">
 
<source lang="php">
−
curl -X POST -H "Content-Type: application/json" -d '{"key":"YOUR_API_KEY","job_number":"123","items":[{"type":"C","expected_quantity":"4","other":"test","notes":"exampleNotes","name":"darrenItem"}]}' http://api.mymobileworkers.com:8080/api/1/jobs/job/items
+
curl -X POST -H "Content-Type: application/json" -d '{ "key":"api_key", "validate_only":"false", "update_existing":true, "folders":[  {  "name":"folder_test", "notes":"testing", "order_position": "folder_key":"folder_key"} ]}' http://api.mymobileworkers.com:8080/api/1/companies/company/attachment_folders
 
</source>
 
</source>
  
Line 158: Line 146:
 
<source lang="java">
 
<source lang="java">
 
{
 
{
−
  "result":"failed",
+
    "failed": [],
−
  "failed":[
+
    "successful": [
−
      {
+
        {
−
        "item":{
+
             "customer_name": "folder_test"
−
            "name":"item2",
+
        }
−
            "type":null,
+
    ]
−
            "notes":null,
+
−
        },
+
−
        "errors":[
+
−
            {
+
−
              "error_code":"JBI002",
+
−
              "error_message":"Job item type is null"
+
−
             }
+
−
        ]
+
−
      }
+
−
  ],
+
−
  "valid":[
+
−
      {
+
−
        "name":"item1",
+
−
        "type":"C",
+
−
        "notes":"notes",
+
−
        "barcodes":"barcode,barcode1"
+
−
      }
+
−
  ]
+
 
}
 
}
 
</source>
 
</source>

Latest revision as of 11:03, 12 March 2018

Contents

[edit] Summary

A company folder 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.


[edit] Multi Part Form Data

Create Item
URL http://base_url/api_path/version/companies/company/attachment_folders
Type POST
Params: api_key required
file required
update_existing optional (default = false)
validate_only optional (default = false)
Response JSON

[edit] JSON As Body

Create Job - JSON
URL http://:base_url/:api_path/:version/companies/company/attachment_folders
Type POST
JSON
{key, validate_only(optional), update_existing(optional), folders[]} 		required
Response JSON

[edit] JSON Contents

The JSON file is passed in the post as the "file"
Field Expected Data Required
name varchar(45) ✓
order_position int(4) ✓
folder_key varchar(45) ✓
notes varchar(45)
Fields exclusive to JSON body format:
Standard Fields
Field Expected Data Required
key string - company api key ✓
validate_only boolean
update_existing boolean

[edit] Example Input

[edit] Multi Part Form Data 

{"folders":[
      {
        "name":"folder_test",
        "notes":"testing",
        "order_position":1,
        "folder_key":"folder_key"
      }
   ]}

[edit] JSON As Body 

{
   "key":"api_key",
   "validate_only":"false",
   "update_existing":true,
   "folders":[
      {
        "name":"folder_test",
        "notes":"testing",
        "order_position":1,
        "folder_key":"folder_key"
      }
   ]
}

[edit] Example Curl Requests

[edit] Multi Part Form Data 

curl -F validate_only=false -F update_existing=true -F api_key=[YOUR_API_KEY] -F file=@/Users/darrenatherton/Desktop/webAPICurling/create_attachment_folders.txt http://api.mymobileworkers.com:8080/api/1/companies/company/attachment_folders

[edit] JSON As Body 

curl -X POST -H "Content-Type: application/json" -d '{ "key":"api_key", "validate_only":"false", "update_existing":true, "folders":[  {  "name":"folder_test", "notes":"testing", "order_position": "folder_key":"folder_key"} ]}' http://api.mymobileworkers.com:8080/api/1/companies/company/attachment_folders

[edit] Responses

[edit] Example JSON 

{
    "failed": [],
    "successful": [
        {
            "customer_name": "folder_test"
        }
    ]
}
Retrieved from ‘https://docs.mymobileworkers.com/index.php?title=Create_Company_Attachment_Folders&oldid=1090’
Personal tools
Namespaces

Variants
Actions
Navigation
Toolbox