Ryanmt: /* Multi Part Form Data */

2017-07-21T22:23:37Z

‎Multi Part Form Data

Ryanmt: /* JSON As Body */

2017-07-21T22:23:25Z

‎JSON As Body

Ryanmt: Created page with "== Summary == This method is a copy of the normal create mobile users except it will locate and update mobile users by their external id as primary key rather than the userna..."

2017-07-21T22:22:48Z

Created page with "== Summary == This method is a copy of the normal create mobile users except it will locate and update mobile users by their external id as primary key rather than the userna..."

New page

== Summary ==

This method is a copy of the normal create mobile users except it will locate and update mobile users by their external id as primary key rather than the username.

If you attempt to create an item with no external ID provided an exception will be thrown, also if there are more than one mobile user with the same external id only the first will be updated

A mobile user 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.

The 'create mobile user' method accepts an array of mobile users to be added to the system. If the 'update_existing' parameter is set, then any existing items will be updated in the system. If set to false or not provided, then any item where the username is not unique will be rejected.

If 'validate_only' is set, the assets will only be validated but not actually inserted into the database. This can be used to check an entire dataset for errors before submitting.

''' The password is encrypted once received by the API, as a result it will be impossible to ever recover/receive the password back in a response. If the user is updated and you do not wish to update the password pass a null value '''

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

! Create Asset
! colspan="2" |
|-
! URL
| colspan="2" | https://base_url/api_path/version/mobile_users/external
|-
! Type
| colspan="2" |POST
|-
! Params:
| api_key || required
|-
!
| file || required
|-
!
| update_existing || optional (default = false)
|-
!
| validate_only || optional (default = false)
|-
! Response
| colspan="2" | JSON
|}

==== JSON As Body ====
{| border="1" class="wikitable"
! Create Job - JSON
! colspan="2" |
|-
! URL
| colspan="2" | https://base_url/api_path/version/mobile_users/external
|-
! Type
| colspan="2" |POST
|-
!
| JSON <br /> {key, validate_only(optional), update_existing(optional), mobile_users[]} ||| 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
|-
! username
| varchar(32) || ✓
|-
! external_id
| varchar(45) || ✓
|-
! email
| varchar(127) ||
|-
! fullname
| varchar(32) ||
|-
! password
| varchar(45) || ✓
|-
! branch_id
| {"name":"<branchName>"} <br /><span style="font-size:80%; font-weight:normal">*nested JSON object</span>||
|-
! engineer_reg_number
| 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">
{ "mobile_users":[
{
"username":"MrUser",
"branch_id":{
"name":"Hub"
},
"engineer_registration_number":"ABC",
"fullname":"Bob User",
"contact_number":"0192576845",
"email":"MrUser@mymobileworkers.com",
"password":"VerySecure"

}
]}
</source>

==== JSON As Body ====

<source lang="java">
{
"key":"myApiKey",
"update_existing":true,
"mobile_users":[
{
"username":"MrUser",
"branch_id":{
"name":"Hub"
},
"engineer_registration_number":"ABC",
"fullname":"Bob User",
"contact_number":"0192576845",
"email":"MrUser@mymobileworkers.com",
"password":"VerySecure"

}
]}
</source>

== Example Curl Requests ==

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

curl -F validate_only=false -F update_existing=true -F api_key=APIKEY -F file=@/Users/user/Desktop/webAPICurling/create_mobile_users.txt https://api.mymobileworkers.com:8181/api/1/mobile_users

==== JSON As Body ====

curl -X POST -H "Content-Type: application/json" -d '{"key":"myApiKey","update_existing":true,"mobile_users":[{"username":"MrUser","external_id":"my_unique_id","branch_id":{"name":"Hub"},"engineer_registration_number":"ABC","fullname":"Bob User","contact_number":"0192576845","email":"MrUser@mymobileworkers.com","password":"VerySecure"}]}' https://api.mymobileworkers.com:8181/api/1/mobile_users/external

== Responses ==

=== Example JSON ===
<source lang="java">
{
"failed": [
{
"name": "MrBadUser",
"errors": [
{
"error_code": "MBU004",
"error_message": "No Password provided"
}
]
}
],
"successful": [
{
"name": "MrUser"
}
]
}
</source>

@@ Line 122: / Line 122: @@
+       {
           "username":"MrUser",
           "branch_id":{
              "name":"Hub"

Create Mobileuser by External Id - Revision history

Ryanmt: /* Multi Part Form Data */

Ryanmt: /* JSON As Body */

Ryanmt: Created page with "== Summary == This method is a copy of the normal create mobile users except it will locate and update mobile users by their external id as primary key rather than the userna..."