Input URI
|
{base url} + DESIGN/RC/KDS-41-20-2022/WD-ANAL |
|---|
Active Methods
|
POST |
|---|
JSON Schema
Details
{
"type": "object",
"required": [
"Argument"
],
"additionalProperties": false,
"properties": {
"Argument": {
"type": "object",
"description": "Execute RC Wall design calculation. If SELECTIONS is omitted or empty, all wall IDs and all stories are included.",
"additionalProperties": false,
"properties": {
"SELECTIONS": {
"type": "array",
"description": "List of wall and story selections to perform design for. If omitted or empty, all walls and all stories are included.",
"minItems": 0,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"WALL_IDS": {
"type": "object",
"description": "Wall IDs to perform design for. If omitted, all walls are included.",
"additionalProperties": false,
"properties": {
"KEYS": {
"type": "array",
"description": "Specify each Wall ID.",
"items": {
"type": "integer"
}
},
"TO": {
"type": "string",
"description": "Specify Wall ID Range, e.g. '1to20'."
}
},
"oneOf": [
{
"required": [
"KEYS"
],
"not": {
"required": [
"TO"
]
}
},
{
"required": [
"TO"
],
"not": {
"required": [
"KEYS"
]
}
}
]
},
"STORY": {
"type": "array",
"description": "List of story names to perform design for. If omitted, all stories are included.",
"items": {
"type": "string"
}
}
}
}
}
}
}
}
}
"type": "object",
"required": [
"Argument"
],
"additionalProperties": false,
"properties": {
"Argument": {
"type": "object",
"description": "Execute RC Wall design calculation. If SELECTIONS is omitted or empty, all wall IDs and all stories are included.",
"additionalProperties": false,
"properties": {
"SELECTIONS": {
"type": "array",
"description": "List of wall and story selections to perform design for. If omitted or empty, all walls and all stories are included.",
"minItems": 0,
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"WALL_IDS": {
"type": "object",
"description": "Wall IDs to perform design for. If omitted, all walls are included.",
"additionalProperties": false,
"properties": {
"KEYS": {
"type": "array",
"description": "Specify each Wall ID.",
"items": {
"type": "integer"
}
},
"TO": {
"type": "string",
"description": "Specify Wall ID Range, e.g. '1to20'."
}
},
"oneOf": [
{
"required": [
"KEYS"
],
"not": {
"required": [
"TO"
]
}
},
{
"required": [
"TO"
],
"not": {
"required": [
"KEYS"
]
}
}
]
},
"STORY": {
"type": "array",
"description": "List of story names to perform design for. If omitted, all stories are included.",
"items": {
"type": "string"
}
}
}
}
}
}
}
}
}
Request Examples
Example
{
"Argument": {
"SELECTIONS": [
{
"WALL_IDS": {
"KEYS": [
1,
2,
3
]
},
"STORY": [
"B1F",
"1F"
]
},
{
"WALL_IDS": {
"TO": "10to20"
},
"STORY": [
"2F",
"3F"
]
}
]
}
}
"Argument": {
"SELECTIONS": [
{
"WALL_IDS": {
"KEYS": [
1,
2,
3
]
},
"STORY": [
"B1F",
"1F"
]
},
{
"WALL_IDS": {
"TO": "10to20"
},
"STORY": [
"2F",
"3F"
]
}
]
}
}
Response Examples
Example
{
"message": "success"
}
"message": "success"
}
Specifications
Keyed Object Entry
| No. | Description | Key | Value Type | Default | Required | |||
|---|---|---|---|---|---|---|---|---|
|
Root Object |
||||||||
|
1 |
Execute RC Wall design calculation. If SELECTIONS is omitted or empty, all wall IDs and all stories are included. |
"Argument" |
object |
- |
Required |
|||
Item (Value Object Schema)
| No. | Description | Key | Value Type | Default | Required | |||
|---|---|---|---|---|---|---|---|---|
|
General |
||||||||
|
1 |
Selections Constraints: • Items: min 0 |
"SELECTIONS" |
Array [object] |
- |
Optional |
|||
|
1.1 |
Wall IDs |
"WALL_IDS" |
object |
- |
Optional |
|||
|
oneOf Choose exactly one of the following keys: "KEYS" or "TO". |
||||||||
|
1.1.1 |
Specify Each Wall ID |
"KEYS" |
Array [integer] |
- |
Optional |
|||
|
1.1.2 |
Specify Wall ID Range |
"TO" |
string |
- |
Optional |
|||
|
1.2 |
Stories |
"STORY" |
Array [string] |
- |
Optional |
|||