RateTagService provides operations for managing rate tags.

addRateTag

Add a rate tag.

Capability required: YieldWrite
License command group: Inventory

Parameters

Parameter	Data Type	Description	Restriction
rateTag	RateTag	The rate tag to add.	Req

Response

RateTagResponse - The response, which indicates if the operation succeeded or failed, and the rate tag.

addRateTags

Add a list of rate tags.

Quota is charged for each object in the request.

Capability required: YieldWrite
License command group: Inventory

Parameters

Parameter	Data Type	Description	Restriction
rateTags	RateTag[]	The list of rate tags to add.	Req

Response

RateTagResponse[] - The list of responses, which indicate if the operations succeeded or failed, and the list of rate tags.

deactivateRateTag

Deactivate a rate tag (specified by ID).

Capability required: YieldWrite
License command group: Inventory

Parameters

Parameter	Data Type	Description	Restriction
rateTagID	long	The ID of the rate tag to deactivate.	Req

Response

BasicResponse - The response, which indicates if the operation succeeded or failed.

deactivateRateTags

Deactivate a list of rate tags (specified by IDs).

Quota is charged for each object in the request.

Capability required: YieldWrite
License command group: Inventory

Parameters

Parameter	Data Type	Description	Restriction
rateTagIDs	long[]	The IDs of the rate tags to deactivate.	Req

Response

BasicResponse[] - The list of responses, which indicate if the operations succeeded or failed.

deleteRateTag

Delete a rate tag (specified by ID).

Capability required: YieldWrite
License command group: Inventory

Parameters

Parameter	Data Type	Description	Restriction
rateTagID	long	The ID of the rate tag to delete.	Req

Response

BasicResponse - The response, which indicates if the operation succeeded or failed.

deleteRateTags

Delete a list of rate tags (specified by IDs).

Quota is charged for each object in the request.

Capability required: YieldWrite
License command group: Inventory

Parameters

Parameter	Data Type	Description	Restriction
rateTagIDs	long[]	The IDs of the rate tags to delete.	Req

Response

BasicResponse[] - The list of responses, which indicate if the operations succeeded or failed.

getRateTag

Get a rate tag (specified by ID).

Added in: Version 16.0.0
Capability required: YieldRead
License command group: Inventory

Parameters

Parameter	Data Type	Description	Restriction
rateTagID	long[]	The ID of the rate tag to retrieve.	Req

Response

RateTag[] - The rate tag.

getRateTagsByAccountID

Get the rate tags for the account (in the request).

Changed in: Version 16.0.0
Capability required: YieldRead
License command group: Inventory

Parameters

Parameter	Data Type	Description	Restriction
startElement	int	The first element to retrieve (0-based; if a value <= 0 is entered, it will default to 0).	Req
numElements	int	The number of elements to retrieve (1000 maximum; if a value <=0 is entered, it will default to 1000).	Req

Response

RateTag[] - The list of rate tags (for the account in the request).

updateRateTag

Update a rate tag.

Capability required: YieldWrite
License command group: Inventory

Parameters

Parameter	Data Type	Description	Restriction
rateTag	RateTag	The rate tag to update.	Req

Response

RateTagResponse - The response, which indicates if the operation succeeded or failed, and the rate tag.

updateRateTags

Update a list of rate tags.

Quota is charged for each object in the request.

Capability required: YieldWrite
License command group: Inventory

Parameters

Parameter	Data Type	Description	Restriction
rateTags	RateTag[]	The list of rate tags to update.	Req

Response

RateTagResponse[] - The list of responses, which indicate if the operations succeeded or failed, and the list of rate tags.