GET api/ProviderNegativeKeyword?systemName={systemName}&username={username}&password={password}&providerId={providerId}&keyword={keyword}&comparison={comparison}&offset={offset}&limit={limit}&includeClosed={includeClosed}
Gets all provider negative keywords for provider matching keyword
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
systemName | string |
Required |
|
username | string |
Required |
|
password | string |
Required |
|
providerId | integer |
Required |
|
keyword | string |
Required |
|
comparison | string |
Required |
|
offset | integer |
Default value is 0 |
|
limit | integer |
Default value is 0 |
|
includeClosed | boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
Collection of APIProviderNegativeKeywordName | Description | Type | Additional information |
---|---|---|---|
Id |
Unique identifier |
integer |
None. |
ProviderId |
Unique identifier of provider to which this belongs |
integer |
None. |
State |
Status: Active, Closed or Suspended |
string |
None. |
Keyword |
Textual keyword string |
string |
None. |
Response Formats
application/json, text/json
Sample:
[ { "id": 1, "providerId": 2, "state": "sample string 3", "keyword": "sample string 4" }, { "id": 1, "providerId": 2, "state": "sample string 3", "keyword": "sample string 4" } ]
application/xml, text/xml
Sample:
<ArrayOfAPIProviderNegativeKeyword xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Rochester.Models"> <APIProviderNegativeKeyword> <Id>1</Id> <Keyword>sample string 4</Keyword> <ProviderId>2</ProviderId> <State>sample string 3</State> </APIProviderNegativeKeyword> <APIProviderNegativeKeyword> <Id>1</Id> <Keyword>sample string 4</Keyword> <ProviderId>2</ProviderId> <State>sample string 3</State> </APIProviderNegativeKeyword> </ArrayOfAPIProviderNegativeKeyword>