EmailCategoryQuery
Click here for a complete list of operations.
GetCategoriesByCommunity
Test
To test the operation using the HTTP POST protocol, click the 'Invoke' button.SOAP 1.1
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
POST /ws/21/EmailCategoryQuery.asmx HTTP/1.1 Host: api.imodules.com Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "http://imodules.com/WebServices/EmailCategoryQuery/GetCategoriesByCommunity" <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <GetCategoriesByCommunity xmlns="http://imodules.com/WebServices/EmailCategoryQuery/"> <login>string</login> <password>string</password> <communityId>int</communityId> </GetCategoriesByCommunity> </soap:Body> </soap:Envelope>
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <GetCategoriesByCommunityResponse xmlns="http://imodules.com/WebServices/EmailCategoryQuery/"> <GetCategoriesByCommunityResult> <AllCategoryResults Column="string" Community_Id="int" is_community_opt_out="boolean" is_inherited_down="boolean" /> <AllCategoryResults Column="string" Community_Id="int" is_community_opt_out="boolean" is_inherited_down="boolean" /> <Error Code="int" Description="string" /> </GetCategoriesByCommunityResult> </GetCategoriesByCommunityResponse> </soap:Body> </soap:Envelope>
SOAP 1.2
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
POST /ws/21/EmailCategoryQuery.asmx HTTP/1.1 Host: api.imodules.com Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <GetCategoriesByCommunity xmlns="http://imodules.com/WebServices/EmailCategoryQuery/"> <login>string</login> <password>string</password> <communityId>int</communityId> </GetCategoriesByCommunity> </soap12:Body> </soap12:Envelope>
HTTP/1.1 200 OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <GetCategoriesByCommunityResponse xmlns="http://imodules.com/WebServices/EmailCategoryQuery/"> <GetCategoriesByCommunityResult> <AllCategoryResults Column="string" Community_Id="int" is_community_opt_out="boolean" is_inherited_down="boolean" /> <AllCategoryResults Column="string" Community_Id="int" is_community_opt_out="boolean" is_inherited_down="boolean" /> <Error Code="int" Description="string" /> </GetCategoriesByCommunityResult> </GetCategoriesByCommunityResponse> </soap12:Body> </soap12:Envelope>
HTTP GET
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
GET /ws/21/EmailCategoryQuery.asmx/GetCategoriesByCommunity?login=string&password=string&communityId=string HTTP/1.1 Host: api.imodules.com
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <ArrayOfAllCategoryResults xmlns="http://imodules.com/WebServices/EmailCategoryQuery/"> <AllCategoryResults Column="string" Community_Id="int" is_community_opt_out="boolean" is_inherited_down="boolean" /> <AllCategoryResults Column="string" Community_Id="int" is_community_opt_out="boolean" is_inherited_down="boolean" /> <Error Code="int" Description="string" /> </ArrayOfAllCategoryResults>
HTTP POST
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
POST /ws/21/EmailCategoryQuery.asmx/GetCategoriesByCommunity HTTP/1.1 Host: api.imodules.com Content-Type: application/x-www-form-urlencoded Content-Length: length login=string&password=string&communityId=string
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <ArrayOfAllCategoryResults xmlns="http://imodules.com/WebServices/EmailCategoryQuery/"> <AllCategoryResults Column="string" Community_Id="int" is_community_opt_out="boolean" is_inherited_down="boolean" /> <AllCategoryResults Column="string" Community_Id="int" is_community_opt_out="boolean" is_inherited_down="boolean" /> <Error Code="int" Description="string" /> </ArrayOfAllCategoryResults>