GET api/Partner/GetPartners?PageIndex={PageIndex}&PageLimit={PageLimit}&Search={Search}&Enabled={Enabled}&Type={Type}
Get partners
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
PageIndex |
Page index |
integer |
Default value is 0 |
PageLimit |
Page limit (max 250) |
integer |
Default value is 50 |
Search |
Search value |
string |
None. |
Enabled |
Filter on Enabled status (empty param = all) |
boolean |
None. |
Type |
Filter on Type (empty param = all) |
PartnerType |
None. |
Body Parameters
None.
Response Information
Resource Description
List of partners
ResponseOfPagedOfPartnerName | Description | Type | Additional information |
---|---|---|---|
Data | PagedOfPartner |
None. |
|
Result | boolean |
None. |
|
Message | string |
None. |
|
Errors | Object |
None. |
Response Formats
application/json, text/json
Sample:
{ "Data": { "$id": "2", "Items": 1, "List": [ { "$id": "3", "CampaignCode": "sample string 1", "CountryCode": "sample string 2", "CustomContractDuration": 3, "CustomContractDurationCompany": 4, "CustomContractDurationDirect": 5, "CustomDocuments": true, "CustomName": "sample string 7", "CustomerServiceEmail": "sample string 8", "CustomerServicePhone": "sample string 9", "CustomTemplate": "sample string 10", "Enabled": true, "Id": 12, "Name": "sample string 13", "Password": "sample string 14", "PaymentEmail": "sample string 15", "PaymentExternal": true, "Type": 0, "Username": "5b473dac-6666-4e05-bc90-964cbe34ff35", "WebCrmOwnerId": 18 }, { "$ref": "3" } ], "PageIndex": 2, "TotalItems": 3, "TotalPages": 4 }, "Result": true, "Message": "sample string 2", "Errors": { "$id": "4" } }