Header Name | Header Value |
---|---|
Content-Type | application/json[; charset=utf-8] |
Response body is composed of following JSON string.
{
"header" : "FSWEB",
"version": "1.0",
"code" : (number),
"result" : (object | string)
}
"code"
values"code"
can have following values:
-1
: Unknown Error-2
: Invalid Request0
: Success1
: Not Found"code"
value is not zero, you can get the corresponding message from "result"
.
Otherwise, you can get surface parameters through "result" variable.
"result"
DescriptionIf the "code"
value is non-zero, the "result"
is describing the corresponding "code"
case.
If the "code"
value is zero, the "result"
is the object type that describes the result of FindSurface.
The result object format is same as below,
{
"type" : (string),
"rms" : (number),
"param" : (object),
"flags" : (null | array)
}
string
number
object
Specifies the surface parameters according to "type"
value.
{
"ll" : [ (number), (number), (number) ],
"lr" : [ (number), (number), (number) ],
"ur" : [ (number), (number), (number) ],
"ul" : [ (number), (number), (number) ],
"c" : [ (number), (number), (number) ],
"n" : [ (number), (number), (number) ]
}
[ x, y, z ]
[ x, y, z ]
[ x, y, z ]
[ x, y, z ]
[ x, y, z ]
[ x, y, z ]
{
"c" : [ (number), (number), (number) ],
"r" : (number)
}
[ x, y, z ]
number
{
"t" : [ (number), (number), (number) ],
"b" : [ (number), (number), (number) ],
"r" : (number),
"c" : [ (number), (number), (number) ],
"h" : (number),
"n" : [ (number), (number), (number) ]
}
[ x, y, z ]
[ x, y, z ]
number
[ x, y, z ]
number
[ x, y, z ]
{
"t" : [ (number), (number), (number) ],
"tr" : (number),
"b" : [ (number), (number), (number) ],
"br" : (number),
"c" : [ (number), (number), (number) ],
"h" : (number),
"n" : [ (number), (number), (number) ]
}
[ x, y, z ]
number
[ x, y, z ]
number
[ x, y, z ]
number
[ x, y, z ]
{
"c" : [ (number), (number), (number) ],
"n" : [ (number), (number), (number) ],
"mr" : (number),
"tr" : (number)
}
[ x, y, z ]
[ x, y, z ]
number
number
null | array
Array of Inlier & Outlier flag. Each flag has a number value indicating Inlier or Outlier.
0
- Inliersotherwise
- Outliersnull
,
unless you specify an option flag for [Request Inlier & Outlier Flags] on request.
An index order of this array is same as Array of Point Attributes on the requested body. The i th flag indicates whether the i th point in the requested body is an inlier or an outlier. The outliers may be used as the new Point Attributes array in the next requested body to be sent.
Case) When FindSurface has been failed with "Not Found" error.
{
"header" : "FSWEB",
"version": "1.0",
"code" : 1,
"result" : "Not found"
}
Case) When FindSurface has been succeeded to find a Plane.
{
"haeder" : "FSWEB",
"version" : "1.0",
"code" : 0,
"result" : {
"type" : "plane",
"rms" : 0.001772,
"param" : {
"ll": [ -0.5081, -0.4793, -1.556 ],
"lr": [ 0.869, -0.5044, -1.65 ],
"ur": [ 0.9165, 0.3334, -1.178 ],
"ul": [ -0.4606, 0.3584, -1.083 ],
"c" : [ 0.2042, -0.07297, -1.367 ],
"n" : [ 0.05042, -0.4928, 0.8687 ]
},
"flags" : null
}
}