13. Target Groups
Content of this chapter
This chapter contains web service methods concerning creation and editing of target groups.
13.1. ListTargetgroups
Namespace: http://agnitas.org/ws/schemas
Lists all target groups.
13.1.1. Request elements
Note: There is no parameter given.
13.1.2. Response elements
| Element | Data type | Description |
|---|---|---|
| item | List of target group data | List of target group data |
Optional elements:
| Elements | Data type | Description |
|---|---|---|
| id | {http://www.w3.org/2001/XMLSchema}int | ID of target group |
| name | {http://www.w3.org/2001/XMLSchema}string | Name of target groups |
13.1.3. SOAP Faults
This webservice has no specific SOAP faults.
13.2. AddTargetGroup
Namespace: http://agnitas.org/ws/schemas
Creates a new target group. For the syntax of the EQL expression, please consult the EMM manual (chapter „Creating advanced target groups“).
13.2.1. Request elements
| Elements | Data type | Description |
|---|---|---|
| name | {http://www.w3.org/2001/XMLSchema}string | Name of target group |
| description | {http://www.w3.org/2001/XMLSchema}string | Description of target group |
| eql | {http://www.w3.org/2001/XMLSchema}string | Rules of target group |
Optional elements:
| Element | Default behavior, if not specified |
|---|---|
| description | Description is left blank |
13.2.2. Response elements
| Element | Data type | Description |
|---|---|---|
| targetId | {http://www.w3.org/2001/XMLSchema}int | ID of new target group |
13.2.3. SOAP Faults
The webservice returns a SOAP Fault in case of
- missing required elements
- syntax errors in the EQL expression
- content errors in the EQL expression (like unknown profile fields)
13.3. UpdateTargetGroup
Namespace: http://agnitas.com/ws/schemas
Updates an existing target group.
13.3.1. Request elements
| Elements | Data type | Description |
|---|---|---|
| targetID | {http://www.w3.org/2001/XMLSchema}int | ID of target group |
| targetName | {http://www.w3.org/2001/XMLSchema}string | Name of target group |
| description | {http://www.w3.org/2001/XMLSchema}string | Description of target group |
| eql | {http://www.w3.org/2001/XMLSchema}string | Rules of target group |
Optional elements:
| Elements | Default behavior, if not specified |
|---|---|
| targetName | Name of target group remains unchanged |
| description | Description of target group remains unchanged |
| eql | Rules of target group remains unchanged |
13.3.2. Response elements
The response has no elements.
13.3.3. SOAP Faults
The webservice returns a SOAP fault in case of
- missing required elements
- unknown target group ID
- syntax errors in the EQL expression
- content errors in the EQL expression (like unknown profile fields)