CategoryService
CategoryService Description: ASMX, WSDL
Add:
ASMX,
XML
Description: Add a new category.
Name: Must contain only lower-case alphanumeric characters (a-z, 0-9), hyphens (-), or underscores (_). Maximum length of 60 characters.
Description: Maximum length of 90 characters.
IsReadOnly: Setting to 'True' will NOT allow deleting and only allow updates to Description and DirectoryID.
| Parameters: |
| Name |
Type |
Description |
| Name |
String |
|
| Description |
String |
|
| |
| SoapHeader: |
| Name |
Type |
Description |
| Username |
String |
Your API access username. |
| Password |
String |
Your API access password. |
| List |
String |
The account you want to access. |
| |
| Return Value: |
| Type |
Description |
| CategoryDataset.CategoryDataTable |
XSD |
Delete:
ASMX,
XML
Description: Delete existing Category.
| Parameters: |
| Name |
Type |
Description |
| CategoryID |
Int32 |
|
| |
| SoapHeader: |
| Name |
Type |
Description |
| Username |
String |
Your API access username. |
| Password |
String |
Your API access password. |
| List |
String |
The account you want to access. |
| |
| Return Value: |
| Type |
Description |
| Boolean |
|
Exists:
ASMX,
XML
Description: Check if a category exists.
| Parameters: |
| Name |
Type |
Description |
| Name |
String |
|
| |
| SoapHeader: |
| Name |
Type |
Description |
| Username |
String |
Your API access username. |
| Password |
String |
Your API access password. |
| List |
String |
The account you want to access. |
| |
| Return Value: |
| Type |
Description |
| Boolean |
|
ExistsByID:
ASMX,
XML
Description: Check if a CategoryID exists.
| Parameters: |
| Name |
Type |
Description |
| CategoryID |
Int32 |
|
| |
| SoapHeader: |
| Name |
Type |
Description |
| Username |
String |
Your API access username. |
| Password |
String |
Your API access password. |
| List |
String |
The account you want to access. |
| |
| Return Value: |
| Type |
Description |
| Boolean |
|
List:
ASMX,
XML
Description: List Categories.
| Parameters: |
| none |
| |
| SoapHeader: |
| Name |
Type |
Description |
| Username |
String |
Your API access username. |
| Password |
String |
Your API access password. |
| List |
String |
The account you want to access. |
| |
| Return Value: |
| Type |
Description |
| CategoryDataset.CategoryDataTable |
XSD |
ListForMember:
ASMX,
XML
Description: List Categories for a contact with MemberID.
| Parameters: |
| Name |
Type |
Description |
| MemberID |
Int32 |
|
| IsSubscribed |
Boolean |
|
| |
| SoapHeader: |
| Name |
Type |
Description |
| Username |
String |
Your API access username. |
| Password |
String |
Your API access password. |
| List |
String |
The account you want to access. |
| |
| Return Value: |
| Type |
Description |
| CategoryDataset.CategoryDataTable |
XSD |
Load:
ASMX,
XML
Description: Load Category with Name.
| Parameters: |
| Name |
Type |
Description |
| Name |
String |
|
| |
| SoapHeader: |
| Name |
Type |
Description |
| Username |
String |
Your API access username. |
| Password |
String |
Your API access password. |
| List |
String |
The account you want to access. |
| |
| Return Value: |
| Type |
Description |
| CategoryDataset.CategoryDataTable |
XSD |
LoadByID:
ASMX,
XML
Description: Load Category ByID.
| Parameters: |
| Name |
Type |
Description |
| CategoryID |
Int32 |
|
| |
| SoapHeader: |
| Name |
Type |
Description |
| Username |
String |
Your API access username. |
| Password |
String |
Your API access password. |
| List |
String |
The account you want to access. |
| |
| Return Value: |
| Type |
Description |
| CategoryDataset.CategoryDataTable |
XSD |
LoadBySubsetID:
ASMX,
XML
Description: Load Category By SubsetID.
| Parameters: |
| Name |
Type |
Description |
| SubsetID |
Int32 |
|
| |
| SoapHeader: |
| Name |
Type |
Description |
| Username |
String |
Your API access username. |
| Password |
String |
Your API access password. |
| List |
String |
The account you want to access. |
| |
| Return Value: |
| Type |
Description |
| CategoryDataset.CategoryDataTable |
XSD |
MemberAddToCategory:
ASMX,
XML
Description: Add a contact to a category.
| Parameters: |
| Name |
Type |
Description |
| CategoryID |
Int32 |
|
| MemberID |
Int32 |
|
| |
| SoapHeader: |
| Name |
Type |
Description |
| Username |
String |
Your API access username. |
| Password |
String |
Your API access password. |
| List |
String |
The account you want to access. |
| |
| Return Value: |
| Type |
Description |
| CategoryMemberDataset.CategoryMemberDataTable |
XSD |
MemberLoadCategoryByID:
ASMX,
XML
Description: Load a CategoryContact record for a Contact.
| Parameters: |
| Name |
Type |
Description |
| CategoryID |
Int32 |
|
| MemberID |
Int32 |
|
| |
| SoapHeader: |
| Name |
Type |
Description |
| Username |
String |
Your API access username. |
| Password |
String |
Your API access password. |
| List |
String |
The account you want to access. |
| |
| Return Value: |
| Type |
Description |
| CategoryMemberDataset.CategoryMemberDataTable |
XSD |
MemberRemoveFromCategory:
ASMX,
XML
Description: Set contact type to unsub for a category.
| Parameters: |
| Name |
Type |
Description |
| CategoryID |
Int32 |
|
| MemberID |
Int32 |
|
| |
| SoapHeader: |
| Name |
Type |
Description |
| Username |
String |
Your API access username. |
| Password |
String |
Your API access password. |
| List |
String |
The account you want to access. |
| |
| Return Value: |
| Type |
Description |
| Boolean |
|
UnsubscribeLink:
ASMX,
XML
Description: Get the link to unsubscribe from a category.
| Parameters: |
| Name |
Type |
Description |
| CategoryID |
Int32 |
|
| |
| SoapHeader: |
| Name |
Type |
Description |
| Username |
String |
Your API access username. |
| Password |
String |
Your API access password. |
| List |
String |
The account you want to access. |
| |
| Return Value: |
| Type |
Description |
| String |
|
Update:
ASMX,
XML
Description: Update existing Category. Name must contain only lower-case alphanumeric characters (a-z, 0-9), hyphens (-), or underscores (_).