POSitive Anywhere
Web Service Documentation
Service: api
Method: department_create
Create new department.
You must be logged in to use this method.
Basic Authentication is supported.
Basic Authentication is supported.
Parameters
Group: department
localdepartmentid
(string[60])
code
(string[8])
webdescription
(string[101])
description
(string[20])
toplevelgroup
(string[101])
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])
localdepartmentid
(string[60])
departmentid
(long integer)
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 /department_create HTTP/1.1
Authorization: Basic ZGVtbzpkZW1v
Host: localhost:2293
Accept: application/json
Content-Type: application/json
Content-Length: length
{
"department" : {
"localdepartmentid" : "value",
"code" : "value",
"webdescription" : "value",
"description" : "value",
"toplevelgroup" : "value"
}
}
Authorization: Basic ZGVtbzpkZW1v
Host: localhost:2293
Accept: application/json
Content-Type: application/json
Content-Length: length
{
"department" : {
"localdepartmentid" : "value",
"code" : "value",
"webdescription" : "value",
"description" : "value",
"toplevelgroup" : "value"
}
}
Example Response
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: length
{
"department_create_response" : {
"result" : {
"status" : "value",
"localdepartmentid" : "value",
"departmentid" : value
}
}
}
Content-Type: application/json; charset=utf-8
Content-Length: length
{
"department_create_response" : {
"result" : {
"status" : "value",
"localdepartmentid" : "value",
"departmentid" : value
}
}
}
Example Code - JavaScript
function department_create_jsonpost(host,jsondata,username,password,result){
fetch(host + "/department_create", {
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 + "/department_create", {
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/department_create
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/department_create',jsonData)
net.Authorization = net.CreateAuthorizationString (Username, Password, Net:WebBasicAuthentication,Net:NoWrap)
net.ContentType = 'application/json'
net.SetAccept('application/json')
net.Post('https://localhost:2293/department_create',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 /department_create?department-localdepartmentid=value&department-code=value&department-webdescription=value&department-description=value&department-toplevelgroup=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
{
"department_create_response" : {
"result" : {
"status" : "value",
"localdepartmentid" : "value",
"departmentid" : value
}
}
}
Content-Type: application/json; charset=utf-8
Content-Length: length
{
"department_create_response" : {
"result" : {
"status" : "value",
"localdepartmentid" : "value",
"departmentid" : value
}
}
}
Example Code - JavaScript
function department_create_getjson(host,urldata,username,password,result){
fetch(host + "/department_create" +"?" + 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 + "/department_create" +"?" + 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 "department-localdepartmentid=value&department-code=value&department-webdescription=value&department-description=value&department-toplevelgroup=value" https://localhost:2293/department_create
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/department_create?department-localdepartmentid=value&department-code=value&department-webdescription=value&department-description=value&department-toplevelgroup=value')
net.Authorization = net.CreateAuthorizationString (Username, Password, Net:WebBasicAuthentication,Net:NoWrap)
net.SetAccept('application/json')
net.Get('https://localhost:2293/department_create?department-localdepartmentid=value&department-code=value&department-webdescription=value&department-description=value&department-toplevelgroup=value')
Try It - Live
User Name
Password
department-localdepartmentid
department-code
department-webdescription
department-description
department-toplevelgroup
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/department_create? 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
{
"department_create_response" : {
"result" : {
"status" : "value",
"localdepartmentid" : "value",
"departmentid" : value
}
}
}
Content-Type: application/json; charset=utf-8
Content-Length: length
{
"department_create_response" : {
"result" : {
"status" : "value",
"localdepartmentid" : "value",
"departmentid" : value
}
}
}
Example Code - JavaScript
function department_create_restjson(host,id,username,password,result){
fetch(host + "/api/department_create/" + 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/department_create/" + 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/department_create/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/department_create/5')
net.Authorization = net.CreateAuthorizationString (Username, Password, Net:WebBasicAuthentication,Net:NoWrap)
net.SetAccept('application/json')
net.Get('https://localhost:2293/api/department_create/5')
Try It - Live
User Name
Password
id
result
Copyright 2024 POSitive Software Company All Rights Reserved