POSitive Anywhere
Web Service Documentation
Service: api
Method: customer_udf_update
Returns all Customer Categories along with their defined User Defined Fields and Options if applicable.
You must be logged in to use this method.
Basic Authentication is supported.
Basic Authentication is supported.
Parameters
Group: request
localcustomerid
(string[60])
customerid
(string[60])
This parameter is Optional
List: udf
name
(string[60])
value
(string[60])
This parameter is Optional
Possible Return Data
List: ErrorQueue
ErrorNumber
(long integer)
ErrorPosition
(string[255])
ErrorRecordId
(string[255])
ErrorDescription
(string[255])
ErrorRecommendation
(string[255])
Group: result
status
(string[5000])
localcustomerid
(string[60])
customerid
(long integer)
List: udfresult
status
(string[60])
name
(string[60])
udfid
(string[60])
JSON POST (JSON Response)
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
jsondata
result
Example Request
POST /customer_udf_update HTTP/1.1
Authorization: Basic ZGVtbzpkZW1v
Host: localhost:2293
Accept: application/json
Content-Type: application/json
Content-Length: length
{
"request" : {
"localcustomerid" : "value",
"customerid" : "value"
},
"udf" : [
{
"name" : "value",
"value" : "value"
}
]
}
Authorization: Basic ZGVtbzpkZW1v
Host: localhost:2293
Accept: application/json
Content-Type: application/json
Content-Length: length
{
"request" : {
"localcustomerid" : "value",
"customerid" : "value"
},
"udf" : [
{
"name" : "value",
"value" : "value"
}
]
}
Example Response
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: length
{
"customer_udf_update_response" : {
"result" : {
"status" : "value",
"localcustomerid" : "value",
"customerid" : value
},
"udfresult" : [
{
"status" : "value",
"name" : "value",
"udfid" : "value"
}
]
}
}
Content-Type: application/json; charset=utf-8
Content-Length: length
{
"customer_udf_update_response" : {
"result" : {
"status" : "value",
"localcustomerid" : "value",
"customerid" : value
},
"udfresult" : [
{
"status" : "value",
"name" : "value",
"udfid" : "value"
}
]
}
}
Example Code - JavaScript
function customer_udf_update_jsonpost(host,jsondata,username,password,result){
fetch(host + "/customer_udf_update", {
method: "POST",
credentials: "include",
headers: {
"Authorization": "Basic " + btoa(username + ":" + password),
"Content-Type": "application/json",
"Accept": "application/json;",
},
body: jsondata
}).then(function(response){ // get the text out of the reply
return response.text()
}).then( function(text){
// do something with the text reply
textToTextarea(text,result) })
}
var host = "https://localhost:2293"
fetch(host + "/customer_udf_update", {
method: "POST",
credentials: "include",
headers: {
"Authorization": "Basic " + btoa(username + ":" + password),
"Content-Type": "application/json",
"Accept": "application/json;",
},
body: jsondata
}).then(function(response){ // get the text out of the reply
return response.text()
}).then( function(text){
// do something with the text reply
textToTextarea(text,result) })
}
var host = "https://localhost:2293"
Example Code - CURL
CURL --user Username:Password --header "Content-Type: application/json" --header "Accept: application/json" --data-binary @jsonDataFile.json https://localhost:2293/customer_udf_update
Example Code - Clarion with NetTalk
net NetWebClient
net.Authorization = net.CreateAuthorizationString (Username, Password, Net:WebBasicAuthentication,Net:NoWrap)
net.ContentType = 'application/json'
net.SetAccept('application/json')
net.Post('https://localhost:2293/customer_udf_update',jsonData)
net.Authorization = net.CreateAuthorizationString (Username, Password, Net:WebBasicAuthentication,Net:NoWrap)
net.ContentType = 'application/json'
net.SetAccept('application/json')
net.Post('https://localhost:2293/customer_udf_update',jsonData)
Try It - Live
User Name
Password
result
HTTP GET (JSON Response)
The following is a sample JSON GET request and response. The placeholders shown need to be replaced with actual values.
result
Example Request
GET /customer_udf_update?request-localcustomerid=value&request-customerid=value HTTP/1.1
Authorization: Basic ZGVtbzpkZW1v
Host: localhost:2293
Accept: application/json
Authorization: Basic ZGVtbzpkZW1v
Host: localhost:2293
Accept: application/json
Example Response
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: length
{
"customer_udf_update_response" : {
"result" : {
"status" : "value",
"localcustomerid" : "value",
"customerid" : value
},
"udfresult" : [
{
"status" : "value",
"name" : "value",
"udfid" : "value"
}
]
}
}
Content-Type: application/json; charset=utf-8
Content-Length: length
{
"customer_udf_update_response" : {
"result" : {
"status" : "value",
"localcustomerid" : "value",
"customerid" : value
},
"udfresult" : [
{
"status" : "value",
"name" : "value",
"udfid" : "value"
}
]
}
}
Example Code - JavaScript
function customer_udf_update_getjson(host,urldata,username,password,result){
fetch(host + "/customer_udf_update" +"?" + urldata, {
credentials: "include",
headers: {
"Authorization": "Basic " + btoa(username + ":" + password),
"Accept": "application/json;",
}
}).then(function(response){ // get the text out of the reply
return response.text()
}).then( function(text){
// do something with the text reply
})
}
var host = "https://localhost:2293"
fetch(host + "/customer_udf_update" +"?" + urldata, {
credentials: "include",
headers: {
"Authorization": "Basic " + btoa(username + ":" + password),
"Accept": "application/json;",
}
}).then(function(response){ // get the text out of the reply
return response.text()
}).then( function(text){
// do something with the text reply
})
}
var host = "https://localhost:2293"
Example Code - CURL
CURL --user Username:Password --header "Accept: application/json" --get --data "request-localcustomerid=value&request-customerid=value" https://localhost:2293/customer_udf_update
Example Code - Clarion with NetTalk
net NetWebClient
net.Authorization = net.CreateAuthorizationString (Username, Password, Net:WebBasicAuthentication,Net:NoWrap)
net.SetAccept('application/json')
net.Get('https://localhost:2293/customer_udf_update?request-localcustomerid=value&request-customerid=value')
net.Authorization = net.CreateAuthorizationString (Username, Password, Net:WebBasicAuthentication,Net:NoWrap)
net.SetAccept('application/json')
net.Get('https://localhost:2293/customer_udf_update?request-localcustomerid=value&request-customerid=value')
Try It - Live
User Name
Password
request-localcustomerid
request-customerid
result
REST GET (JSON Response)
The following is a sample REST request and response. The placeholders shown need to be replaced with actual values.
result
Example Request
GET /api/customer_udf_update? HTTP/1.1
Authorization: Basic ZGVtbzpkZW1v
Host: localhost:2293
Accept: application/json
Authorization: Basic ZGVtbzpkZW1v
Host: localhost:2293
Accept: application/json
Example Response
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: length
{
"customer_udf_update_response" : {
"result" : {
"status" : "value",
"localcustomerid" : "value",
"customerid" : value
},
"udfresult" : [
{
"status" : "value",
"name" : "value",
"udfid" : "value"
}
]
}
}
Content-Type: application/json; charset=utf-8
Content-Length: length
{
"customer_udf_update_response" : {
"result" : {
"status" : "value",
"localcustomerid" : "value",
"customerid" : value
},
"udfresult" : [
{
"status" : "value",
"name" : "value",
"udfid" : "value"
}
]
}
}
Example Code - JavaScript
function customer_udf_update_restjson(host,id,username,password,result){
fetch(host + "/api/customer_udf_update/" + id, {
credentials: "include",
headers: {
"Authorization": "Basic " + btoa(username + ":" + password),
"Accept": "application/json;",
}
}).then(function(response){ // get the text out of the reply
return response.text()
}).then( function(text){
// do something with the text reply
})
}
var host = "https://localhost:2293"
fetch(host + "/api/customer_udf_update/" + id, {
credentials: "include",
headers: {
"Authorization": "Basic " + btoa(username + ":" + password),
"Accept": "application/json;",
}
}).then(function(response){ // get the text out of the reply
return response.text()
}).then( function(text){
// do something with the text reply
})
}
var host = "https://localhost:2293"
Example Code - CURL
CURL --user Username:Password --header "Accept: application/json" https://localhost:2293/api/customer_udf_update/5
Example Code - Clarion with NetTalk
net NetWebClient
net.Authorization = net.CreateAuthorizationString (Username, Password, Net:WebBasicAuthentication,Net:NoWrap)
net.SetAccept('application/json')
net.Get('https://localhost:2293/api/customer_udf_update/5')
net.Authorization = net.CreateAuthorizationString (Username, Password, Net:WebBasicAuthentication,Net:NoWrap)
net.SetAccept('application/json')
net.Get('https://localhost:2293/api/customer_udf_update/5')
Try It - Live
User Name
Password
id
result
Copyright 2024 POSitive Software Company All Rights Reserved