گروه بندی ها — اطلاعات پایه

گروه‌بندی‌ها برای دسته‌بندی اشخاص و شرکت‌ها استفاده می‌شوند و می‌توانند ساختار چندسطحی داشته باشند.‎ این Endpoint گروه‌های موجود یا زیرگروه‌های یک گروه مشخص را برمی‌گرداند تا ID آن‌ها را برای مخاطبان استفاده کنید.‎

POST {{baseURL}}/api/Segment/GetList?apikey={{API_KEY}}

پارامترهای Query

پارامتر	نوع	وضعیت	توضیح
`apikey`	`string`	الزامی	کلید API دیدار.

Content-Type: application/json

بدنه درخواست

string

.شناسه رکورد گروه برای دریافت لیست زیرگروه های مرتبط با این گروه
اگر این فیلد را ارسال کنید فقط زیرگروه های مرتبط با شناسه گروهی که ارسال کردید در پاسخ

{
  "ParentId": "e381080f-14fe-4335-b211-7187aae983fa"
}

curl --location --request POST '{{baseURL}}/api/Segment/GetList?apikey={{API_KEY}}' \
--header 'Content-Type: application/json' \
--data '{
  "ParentId": "e381080f-14fe-4335-b211-7187aae983fa"
}'

{
    "Response": [
        {
            "Id": "00058fe3-3838-464f-8ed8-c952b7fff243",
            "Title": "sub-test1",
            "ParentId": "e381080f-14fe-4335-b211-7187aae983fa",
            "ParentTitle": "test1",
            "BackgroundColor": "#080808",
            "FullTitle": "test1 / sub-test1",
            "ShowInAddContactForm": false,
            "ShowInAddDealForm": false,
            "ShowInAddCaseForm": false,
            "Segments": []
        },
        {
            "Id": "2000fc65-443f-4c9f-8b87-a0cfef798a66",
            "Title": "زیر مجموعه test1",
            "ParentId": "e381080f-14fe-4335-b211-7187aae983fa",
            "ParentTitle": "test1",
            "BackgroundColor": "#080808",
            "FullTitle": "test1 / زیر مجموعه test1",
            "ShowInAddContactForm": true,
            "ShowInAddDealForm": true,
            "ShowInAddCaseForm": true,
            "Segments": []
        }
    ]
}

{
    "Response": [
        {
            "Id": "e381080f-14fe-4335-b211-7187aae983fa",
            "Title": "test1",
            "ParentId": "00000000-0000-0000-0000-000000000000",
            "ParentTitle": "",
            "BackgroundColor": "#080808",
            "FullTitle": " / test1",
            "ShowInAddContactForm": true,
            "ShowInAddDealForm": true,
            "ShowInAddCaseForm": true,
            "Segments": [
                {
                    "Id": "00058fe3-3838-464f-8ed8-c952b7fff243",
                    "Title": "sub-test1",
                    "ParentId": "e381080f-14fe-4335-b211-7187aae983fa",
                    "ParentTitle": "test1",
                    "BackgroundColor": "#080808",
                    "FullTitle": "test1 / sub-test1",
                    "ShowInAddContactForm": false,
                    "ShowInAddDealForm": false,
                    "ShowInAddCaseForm": false,
                    "Segments": []
                },
                {
                    "Id": "2000fc65-443f-4c9f-8b87-a0cfef798a66",
                    "Title": "زیر مجموعه test1",
                    "ParentId": "e381080f-14fe-4335-b211-7187aae983fa",
                    "ParentTitle": "test1",
                    "BackgroundColor": "#080808",
                    "FullTitle": "test1 / زیر مجموعه test1",
                    "ShowInAddContactForm": true,
                    "ShowInAddDealForm": true,
                    "ShowInAddCaseForm": true,
                    "Segments": []
                }
            ]
        }
    ]
}

لینک های مرتبط

{
  "ParentId": "e381080f-14fe-4335-b211-7187aae983fa"
}

curl --location --request POST '{{baseURL}}/api/Segment/GetList?apikey={{API_KEY}}' \
--header 'Content-Type: application/json' \
--data '{
  "ParentId": "e381080f-14fe-4335-b211-7187aae983fa"
}'

{
    "Response": [
        {
            "Id": "00058fe3-3838-464f-8ed8-c952b7fff243",
            "Title": "sub-test1",
            "ParentId": "e381080f-14fe-4335-b211-7187aae983fa",
            "ParentTitle": "test1",
            "BackgroundColor": "#080808",
            "FullTitle": "test1 / sub-test1",
            "ShowInAddContactForm": false,
            "ShowInAddDealForm": false,
            "ShowInAddCaseForm": false,
            "Segments": []
        },
        {
            "Id": "2000fc65-443f-4c9f-8b87-a0cfef798a66",
            "Title": "زیر مجموعه test1",
            "ParentId": "e381080f-14fe-4335-b211-7187aae983fa",
            "ParentTitle": "test1",
            "BackgroundColor": "#080808",
            "FullTitle": "test1 / زیر مجموعه test1",
            "ShowInAddContactForm": true,
            "ShowInAddDealForm": true,
            "ShowInAddCaseForm": true,
            "Segments": []
        }
    ]
}

{
    "Response": [
        {
            "Id": "e381080f-14fe-4335-b211-7187aae983fa",
            "Title": "test1",
            "ParentId": "00000000-0000-0000-0000-000000000000",
            "ParentTitle": "",
            "BackgroundColor": "#080808",
            "FullTitle": " / test1",
            "ShowInAddContactForm": true,
            "ShowInAddDealForm": true,
            "ShowInAddCaseForm": true,
            "Segments": [
                {
                    "Id": "00058fe3-3838-464f-8ed8-c952b7fff243",
                    "Title": "sub-test1",
                    "ParentId": "e381080f-14fe-4335-b211-7187aae983fa",
                    "ParentTitle": "test1",
                    "BackgroundColor": "#080808",
                    "FullTitle": "test1 / sub-test1",
                    "ShowInAddContactForm": false,
                    "ShowInAddDealForm": false,
                    "ShowInAddCaseForm": false,
                    "Segments": []
                },
                {
                    "Id": "2000fc65-443f-4c9f-8b87-a0cfef798a66",
                    "Title": "زیر مجموعه test1",
                    "ParentId": "e381080f-14fe-4335-b211-7187aae983fa",
                    "ParentTitle": "test1",
                    "BackgroundColor": "#080808",
                    "FullTitle": "test1 / زیر مجموعه test1",
                    "ShowInAddContactForm": true,
                    "ShowInAddDealForm": true,
                    "ShowInAddCaseForm": true,
                    "Segments": []
                }
            ]
        }
    ]
}