Add new article

v1.0.0

Input

{
  "type": "object",
  "description": "The ArticleDTO Class.\nContains relevant fields of Article DTO by masking actual Article entity's fields in application.\n            ",
  "required": [
    "availableGyms",
    "measureUnit",
    "name",
    "price",
    "type"
  ],
  "properties": {
    "activeStatus": {
      "type": "boolean",
      "description": "Active Status "
    },
    "applyForAllGyms": {
      "type": "boolean"
    },
    "articleId": {
      "type": "integer",
      "format": "int32"
    },
    "availableGyms": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "The GymDTO Class.\nContains relevant fields of Gym DTO by masking actual Gym entity's fields in application.\n            ",
        "properties": {
          "externalGymNumber": {
            "type": "integer",
            "format": "int32"
          },
          "gymId": {
            "type": "integer",
            "format": "int32"
          },
          "gymName": {
            "type": "string"
          },
          "location": {
            "type": "string"
          }
        },
        "additionalProperties": false
      }
    },
    "availableQty": {
      "type": "number",
      "format": "decimal",
      "description": "Default AvailableQty"
    },
    "barcode": {
      "type": "string"
    },
    "createdDate": {
      "type": "string",
      "format": "date-time"
    },
    "createdUser": {
      "type": "string"
    },
    "cronExpression": {
      "type": "string",
      "description": "Access Schedule CRON Expression "
    },
    "description": {
      "type": "string"
    },
    "discount": {
      "type": "number",
      "format": "decimal"
    },
    "employeeDiscount": {
      "type": "number",
      "format": "decimal",
      "description": "Default EmployeeDiscount"
    },
    "employeePrice": {
      "type": "number",
      "format": "decimal",
      "description": "Default EmployeePrice"
    },
    "gymArticles": {
      "type": "array",
      "description": "Gym Customizations ",
      "items": {
        "type": "object",
        "description": "The GymArticleDetailsDTO Class.\nContains fields of GymArticleDetails DTO in application.\n            ",
        "properties": {
          "articleId": {
            "type": "integer",
            "format": "int32"
          },
          "availableQty": {
            "type": "number",
            "format": "decimal"
          },
          "createdUser": {
            "type": "string",
            "description": "Created User "
          },
          "employeeDiscount": {
            "type": "number",
            "format": "decimal"
          },
          "employeePrice": {
            "type": "number",
            "format": "decimal"
          },
          "gymId": {
            "type": "integer",
            "format": "int32",
            "description": "Gym Id where article is related "
          },
          "gymIdList": {
            "type": "string",
            "description": "GymId - Gym Id string with comma separated GymIds "
          },
          "gymName": {
            "type": "string",
            "description": "Gym Name"
          },
          "id": {
            "type": "integer",
            "format": "int32"
          },
          "isDefault": {
            "type": "boolean",
            "description": "Set as the default values for the article "
          },
          "isInventoryItem": {
            "type": "boolean"
          },
          "isObsolete": {
            "type": "boolean"
          },
          "modifiedUser": {
            "type": "string",
            "description": "Modified user"
          },
          "reorderLevel": {
            "type": "number",
            "format": "decimal"
          },
          "revenueAccountId": {
            "type": "integer",
            "format": "int32",
            "description": "Revenue account Id"
          },
          "sellingPrice": {
            "type": "number",
            "format": "decimal"
          }
        },
        "additionalProperties": false
      }
    },
    "isAddOn": {
      "type": "boolean"
    },
    "isInventoryItem": {
      "type": "boolean",
      "description": "Default IsInventoryItem of the Article "
    },
    "isObsolete": {
      "type": "boolean",
      "description": "Default IsObsolete of the Article "
    },
    "measureUnit": {
      "type": "string"
    },
    "modifiedDate": {
      "type": "string",
      "format": "date-time"
    },
    "modifiedUser": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "number": {
      "type": "integer",
      "format": "int32"
    },
    "price": {
      "type": "number",
      "format": "decimal"
    },
    "reorderLevel": {
      "type": "number",
      "format": "decimal",
      "description": "Deafault ReorderLevel"
    },
    "revenueAccountId": {
      "type": "integer",
      "format": "int32",
      "description": "Default Revenue account"
    },
    "sellingPrice": {
      "type": "number",
      "format": "decimal",
      "description": "Default SellingPrice"
    },
    "tags": {
      "type": "string"
    },
    "type": {
      "type": "string"
    },
    "vat": {
      "type": "number",
      "format": "decimal"
    },
    "vatApplicable": {
      "type": "boolean",
      "description": "VAT Applicable "
    }
  },
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "The DefaultResponseDTO Class.\nContains fields of DefaultResponse DTO in application.\n            ",
  "properties": {
    "isError": {
      "type": "boolean"
    },
    "message": {
      "type": "string"
    },
    "responseException": {
      "type": "object"
    },
    "result": {
      "type": "object"
    }
  },
  "additionalProperties": false
}