واحد کالا

نام موجودیت :واحد
نام سیستمی : Unit
مسیر api ها : https://accounting.samyar.cloud/Unit
کلید اصلی : UnitId


ویژگیها (properties)

لیست فیلدهای موجودیت کالا در زیر آمده است.


ویژگیعنواننوع ثبتنوعموجودیت اصلیشرح
UnitIdشناسه واحدسیستمیintکلید اصلی
Titleعنواناجباریstring
UnitTypeنوعاجباریint1- اصلی
2- فرعی
BaseUnitIdشناسه واحد اصلیاجباری مشروطintواحدفقط برای واحد فرعی اجباری است
BaseUnit_Titleعنوان واحد اصلیفقط خواندنیstringواحدفقط برای واحد فرعی مقدار دارد
Ratioنسبت واحد اصلی و فرعیاجباری مشروطdecimalکالافقط برای واحد فرعی اجباری است
CreatedDateتاریخ ایجادسیستمیdate
CreatedUserIDشناسه کاربر ایجاد کنندهاجباریintکاربران
ModifiedDateتاریخ ویرایشسیستمیdate
ModifiedUserIDشناسه کاربر ویرایش کنندهاجباریintکاربران

متد ایجاد

مسیر : https://accounting.samyar.cloud/ِUnit/Create
متد ارسال : POST
نمونه پارامترهای ارسالی جهت ایجاد واحد در زیر آمده است .

پارامترهای ورودی ایجاد


// پارامترهای ورودی به صورت Form Data ارسال می شود
Title: گرم
UnitType: 2
Ratio: 0.001
BaseUnitId: 2
پارامترهای خروجی ایجاد


در صورتی که عملیات با موفقیت انجام شود MessageType برابر 3 ، در صورتی که با اخطار انجام شود عدد 2 و در صورتی که با خطا مواجه شده و انجام نشود برابر 1 خواهد بود.

// پارامترهای خروجی به صورت جیسون دریافت می شود
  "Message": "آیتم با موفقیت اضافه شد .",
  "MessageType": 3,

  "UnitId": 10,
  "Title": "گرم",
  "UnitType": 2,
  "BaseUnitId": 2,
  "BaseUnit_Title": "کیلوگرم",
  "Ratio": 0.001,

  "CreatedDate": "2019-09-04T08:25:52.2708642+04:30",
  "CreatedUserID": 2,
  "ModifiedDate": "2019-09-04T08:25:52.2709418+04:30",
  "ModifiedUserID": 2


متد ویرایش

مسیر : https://accounting.samyar.cloud/Unit/Update
متد ارسال : POST
نمونه پارامترهای ارسالی جهت ویرایش در زیر آمده است .

پارامترهای ورودی ویرایش

// پارامترهای ورودی به صورت Form Data ارسال می شود
Title: گرم
UnitId: 10

پارامترهای خروجی ویرایش

مشابه متد ایجاد

متد حذف

مسیر : https://accounting.samyar.cloud/ِUnit/Delete/{UnitId}
متد ارسال : POST

پارامترهای ورودی حذف

DetailId Ex : https://accounting.samyar.cloud/UnitId/Delete/28 
پارامترهای خروجی حذف


// پارامترهای خروجی به صورت جیسون دریافت می شود
{
UnitId: 28
Message: "آیتم با موفقیت حذف شد ."
MessageType: 3
}


متد گرفتن یک آیتم (Get)

مسیر : https://accounting.samyar.cloud/Unit/Get/{UnitId}
متد ارسال : GET
این متد کلید یک موجودیت را دریافت کرده و مقادیر مربوط با آن را برمی گرداند .


پارامترهای ورودی Get


GoodsId Ex : https://accounting.samyar.cloud/Unit/Get/24 
پارامترهای خروجی Get


مشابه متد ایجاد


متد گرفتن همه آیتم ها (GetSome)

مسیر : https://accounting.samyar.cloud/Unit/GetSome
روش ارسال : POST

پارامترهای ورودی GetSome


// پارامترهای ورودی به صورت Form Data ارسال می شود
MasterId: 0 // استفاده نشده
Skip: 0 // استفاده نشده
Take: 10000 // حداکثر تعداد آیتم برگشتی
OrderField: Title // مرتب سازی بر اساس
Order: asc // صعودی یا نزولی
View:  // استفاده نشده
Force: false // سیستمی
پارامترهای خروجی GetSome


{
  "itemCount": 8,
  "values": [
    {
      "Message": null,
      "MessageType": 0,
      "BaseUnit_Title": null,
      "CreatedDate": "2017-10-09T13:20:58.6892328",
      "CreatedUserID": 2,
      "ModifiedDate": "2017-10-09T13:20:58.6892328",
      "ModifiedUserID": 2,
      "UnitId": 2,
      "Title": "کیلوگرم",
      "UnitType": 1,
      "BaseUnitId": null,
      "Ratio": null
    },
    {
      "Message": null,
      "MessageType": 0,
      "BaseUnit_Title": "کیلوگرم",
      "CreatedDate": "2019-09-04T08:25:52.2708642",
      "CreatedUserID": 2,
      "ModifiedDate": "2019-09-04T08:29:25.3824354",
      "ModifiedUserID": 2,
      "UnitId": 10,
      "Title": "گرم",
      "UnitType": 2,
      "BaseUnitId": 2,
      "Ratio": 0.001000
    }
    , ...
  ],
  "startTime": "2019-09-04T08:37:28.0978582+04:30",
  "endTime": "2019-09-04T08:37:29.097868+04:30",
  "extra": ""
}

Powered by BetterDocs