SizeAdd
Create a new garment size.
Python C++ C# VS Server
Python
BwApi.SizeAdd(garmentId, sizeName, afterSizeId)
C++
BwApiSizeAdd(garmentId, sizeName, afterSizeId);
C#
BwApi.SizeAdd(garmentId, sizeName, afterSizeId);
VS Server
{
"id": "API processing order number",
"function": "SizeAdd",
"params": {
"garmentId": "value",
"sizeName": "value",
"afterSizeId": "value"
}
} Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID |
In | sizeName | The name of the new size |
In | afterSizeId | Add the new size after this size ID, -1 to add as first size |
Out | newSizeId | The ID of the newely created size |
Error/success code (see BwApiErrorCodes enum).
SizeDelete
Delete an existing size.
Python C++ C# VS Server
Python
BwApi.SizeDelete(garmentId, sizeId)
C++
BwApiSizeDelete(garmentId, sizeId);
C#
BwApi.SizeDelete(garmentId, sizeId);
VS Server
{
"id": "API processing order number",
"function": "SizeDelete",
"params": {
"garmentId": "value",
"sizeId": "value"
}
} Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID |
In | sizeId | The size ID to delete |
Error/success code (see BwApiErrorCodes enum).
SizeCurrentGet
Get the current garment size.
Python C++ C# VS Server
Python
BwApi.SizeCurrentGet(garmentId)
C++
BwApiSizeCurrentGet(garmentId);
C#
BwApi.SizeCurrentGet(garmentId);
VS Server
{
"id": "API processing order number",
"function": "SizeCurrentGet",
"params": {
"garmentId": "value"
}
} Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID |
Out | sizeId | Get the current size ID |
Error/success code (see BwApiErrorCodes enum).
SizeCurrentSet
Set the current garment size.
Python C++ C# VS Server
Python
BwApi.SizeCurrentSet(garmentId, sizeId)
C++
BwApiSizeCurrentSet(garmentId, sizeId);
C#
BwApi.SizeCurrentSet(garmentId, sizeId);
VS Server
{
"id": "API processing order number",
"function": "SizeCurrentSet",
"params": {
"garmentId": "value",
"sizeId": "value"
}
} Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID |
In | sizeId | Set size ID as the current size ID |
Error/success code (see BwApiErrorCodes enum).
SizeNameGet
Get a size name.
Python C++ C# VS Server
Python
BwApi.SizeNameGet(garmentId, sizeId)
C++
BwApiSizeNameGet(garmentId, sizeId);
C#
BwApi.SizeNameGet(garmentId, sizeId);
VS Server
{
"id": "API processing order number",
"function": "SizeNameGet",
"params": {
"garmentId": "value",
"sizeId": "value"
}
} Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID |
In | sizeId | The ID of specific size |
Out | sizeName | The name of the size |
Error/success code (see BwApiErrorCodes enum).
SizeNameSet
Set a size name.
Python C++ C# VS Server
Python
BwApi.SizeNameSet(garmentId, sizeId, sizeName)
C++
BwApiSizeNameSet(garmentId, sizeId, sizeName);
C#
BwApi.SizeNameSet(garmentId, sizeId, sizeName);
VS Server
{
"id": "API processing order number",
"function": "SizeNameSet",
"params": {
"garmentId": "value",
"sizeId": "value",
"sizeName": "value"
}
} Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID |
In | sizeId | The ID of specific size |
In | sizeName | The name of the size |
Error/success code (see BwApiErrorCodes enum).
SizeBaseGet
Get the base size.
Python C++ C# VS Server
Python
BwApi.SizeBaseGet(garmentId)
C++
BwApiSizeBaseGet(garmentId);
C#
BwApi.SizeBaseGet(garmentId);
VS Server
{
"id": "API processing order number",
"function": "SizeBaseGet",
"params": {
"garmentId": "value"
}
} Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID |
Out | sizeId | Base size ID |
Error/success code (see BwApiErrorCodes enum).
SizeBaseSet
Set the base size.
Python C++ C# VS Server
Python
BwApi.SizeBaseSet(garmentId, sizeId)
C++
BwApiSizeBaseSet(garmentId, sizeId);
C#
BwApi.SizeBaseSet(garmentId, sizeId);
VS Server
{
"id": "API processing order number",
"function": "SizeBaseSet",
"params": {
"garmentId": "value",
"sizeId": "value"
}
} Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID |
In | sizeId | Base size ID |
Error/success code (see BwApiErrorCodes enum).
GradeRuleAdd
Add a grade rule.
Python C++ C# VS Server
Python
BwApi.GradeRuleAdd(garmentId)
C++
BwApiGradeRuleAdd(garmentId);
C#
BwApi.GradeRuleAdd(garmentId);
VS Server
{
"id": "API processing order number",
"function": "GradeRuleAdd",
"params": {
"garmentId": "value"
}
} Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID |
Out | gradeId | New grade ID |
Error/success code (see BwApiErrorCodes enum).
GradeRuleGet
Get a grade rule.
Python C++ C# VS Server
Python
BwApi.GradeRuleGet(garmentId, gradeId, sizeId)
C++
BwApiGradeRuleGet(garmentId, gradeId, sizeId);
C#
BwApi.GradeRuleGet(garmentId, gradeId, sizeId);
VS Server
{
"id": "API processing order number",
"function": "GradeRuleGet",
"params": {
"garmentId": "value",
"gradeId": "value",
"sizeId": "value"
}
} Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID |
In | gradeId | Existing grade ID |
In | sizeId | Existing size ID |
Out | offsetFromBase | Get the offset from the base size (see BwApiCoordinatesXY) |
Error/success code (see BwApiErrorCodes enum).
GradeRuleSet
Set a grade rule.
Python C++ C# VS Server
Python
BwApi.GradeRuleSet(garmentId, gradeId, sizeId, offsetFromBase)
C++
BwApiGradeRuleSet(garmentId, gradeId, sizeId, offsetFromBase);
C#
BwApi.GradeRuleSet(garmentId, gradeId, sizeId, offsetFromBase);
VS Server
{
"id": "API processing order number",
"function": "GradeRuleSet",
"params": {
"garmentId": "value",
"gradeId": "value",
"sizeId": "value",
"offsetFromBase": "value"
}
} Parameters
Param | Variable | Description |
In | garmentId | Existing garment ID |
In | gradeId | Existing grade ID |
In | sizeId | Existing size ID |
In | offsetFromBase | Set the offset from the base size (see BwApiCoordinatesXY) |
Error/success code (see BwApiErrorCodes enum).