POSitive Anywhere
Web Service Documentation
Service: api
Method: customer_document_update
Receive a document to be added to the Customer's stored documents. Documents with the same name as an existing document will be updated.
You must be logged in to use this method.
Basic Authentication is supported.
Basic Authentication is supported.
Parameters
Group: request
localcustomerid
(string[60])
customerid
(long integer)
description
(string[500])
fileextension
(string[60])
filename
(string[60])
This parameter is Optional
Field: document
document
(long integer)
Document, base 64 encoded
This field usually contains a File. If part of an XML or JSON data request, then the file should be Base64 encoded. If part of a simple POST then the form should be in a Content-Type: multipart/form-data; form with the file as a Binary part to the form.
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)
documentid
(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_document_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,
"description" : "value",
"fileextension" : "value",
"filename" : "value"
},
"document" : "value"
}
Authorization: Basic ZGVtbzpkZW1v
Host: localhost:2293
Accept: application/json
Content-Type: application/json
Content-Length: length
{
"request" : {
"localcustomerid" : "value",
"customerid" : value,
"description" : "value",
"fileextension" : "value",
"filename" : "value"
},
"document" : "value"
}
Example Response
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: length
{
"createcustomer_response" : {
"result" : {
"status" : "value",
"localcustomerid" : "value",
"customerid" : value,
"documentid" : "value"
}
}
}
Content-Type: application/json; charset=utf-8
Content-Length: length
{
"createcustomer_response" : {
"result" : {
"status" : "value",
"localcustomerid" : "value",
"customerid" : value,
"documentid" : "value"
}
}
}
Example Code - JavaScript
function customer_document_update_jsonpost(host,jsondata,username,password,result){
fetch(host + "/customer_document_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_document_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_document_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_document_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_document_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_document_update?request-localcustomerid=value&request-customerid=value&request-description=value&request-fileextension=value&request-filename=value&document=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
{
"createcustomer_response" : {
"result" : {
"status" : "value",
"localcustomerid" : "value",
"customerid" : value,
"documentid" : "value"
}
}
}
Content-Type: application/json; charset=utf-8
Content-Length: length
{
"createcustomer_response" : {
"result" : {
"status" : "value",
"localcustomerid" : "value",
"customerid" : value,
"documentid" : "value"
}
}
}
Example Code - JavaScript
function customer_document_update_getjson(host,urldata,username,password,result){
fetch(host + "/customer_document_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_document_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&request-description=value&request-fileextension=value&request-filename=value&document=value" https://localhost:2293/customer_document_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_document_update?request-localcustomerid=value&request-customerid=value&request-description=value&request-fileextension=value&request-filename=value&document=value')
net.Authorization = net.CreateAuthorizationString (Username, Password, Net:WebBasicAuthentication,Net:NoWrap)
net.SetAccept('application/json')
net.Get('https://localhost:2293/customer_document_update?request-localcustomerid=value&request-customerid=value&request-description=value&request-fileextension=value&request-filename=value&document=value')
Try It - Live
User Name
Password
request-localcustomerid
request-customerid
request-description
request-fileextension
request-filename
document
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_document_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
{
"createcustomer_response" : {
"result" : {
"status" : "value",
"localcustomerid" : "value",
"customerid" : value,
"documentid" : "value"
}
}
}
Content-Type: application/json; charset=utf-8
Content-Length: length
{
"createcustomer_response" : {
"result" : {
"status" : "value",
"localcustomerid" : "value",
"customerid" : value,
"documentid" : "value"
}
}
}
Example Code - JavaScript
function customer_document_update_restjson(host,id,username,password,result){
fetch(host + "/api/customer_document_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_document_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_document_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_document_update/5')
net.Authorization = net.CreateAuthorizationString (Username, Password, Net:WebBasicAuthentication,Net:NoWrap)
net.SetAccept('application/json')
net.Get('https://localhost:2293/api/customer_document_update/5')
Try It - Live
User Name
Password
id
result
Copyright 2024 POSitive Software Company All Rights Reserved