Placement Tag2
GetPlacementTags2List [finished]
Overlays:
Activation:
GetPlacementTags2List.php ? sessionID = ...
[ & ownerID = ... ]
[ & namePattern = ... ]
[ & commentsPattern = ... ]
[ & isBlocked = ... ]
[ & sortField = ... ]
[ & sortOrder = ... ]
[ & limit = ... ]
[ & offset = ... ]
Description:
Returns secondary placement categories, matching specified criteria.
Parameters:
- sessionID: string(16)
- ownerID: uint
- namePattern: string(255)
- commentsPattern: string(255)
- isBlocked: enum('Y','N')
- sortField: enum('name', 'comments', 'isBlocked', 'creationTS', 'modificationTS')
- sortOrder: enum('asc', 'desc')
- limit: uint - limits result to given number of records
- offset: uint - skips given number of records
Results:
<GetPlacementTags2List>
<status>OK</status>
<tagsNumber>1234</tagsNumber> : uint - all records number (if there were no limit and offset)
<tags>
<tag>
<tagID>1234</tagID> : uint
<name>1a</name> : string(255)
<isBlocked>Y</isBlocked> : enum('Y', 'N')
<comments>lala</comments> : string(255)
<creationTS>1242123024</creationTS> : uint
<modificationTS>1242123024</modificationTS> : nullable uint
</tag>
</tags>
</GetPlacementTags2List>
Throw Errors:
AddPlacementTag2 [finished]
Overlays:
Activation:
AddPlacementTag2.php ? sessionID = ...
[ & ownerID = ... ]
& name = ...
[ & comments = ... ]
Description:
Adds a secondary placement category.
Parameters:
- sessionID: string(16)
- ownerID: uint
- name: string(255)
- comments: string
Results:
<AddPlacementTag2>
<status>OK</status>
<tagID>1234</tagID>
</AddPlacementTag2>
Throw Errors:
UpdatePlacementTag2 [finished]
Overlays:
Activation:
UpdatePlacementTag2.php ? sessionID = ... & tagID = ...
[ & name = ... ]
[ & comments = ... ]
[ & isBlocked = ... ]
Description:
Changes a secondary placement category.
Parameters:
- sessionID: string(16)
- tagID: uint
- name: string(255)
- comments: string(255)
- isBlocked: enum('Y','N')
Results:
<UpdatePlacementTag2>
<status>OK</status>
</UpdatePlacementTag2>