Rate groups
Get all rate groups
Returns all rate groups, filtered by unique identifiers and other filters. Note this operation uses Pagination and supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/rateGroups/getAll
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Token identifying the client application. |
| string | required | Access token of the client application. |
| string | required | Name and version of the client application. |
| array of string | optional, max 1000 items | Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token. |
| array of string | optional, max 1000 items | Unique identifiers of the Rate group. Required if |
| array of string | optional, max 1000 items | Unique identifiers of the Service. Required if |
| string | optional, max 1000 items | Identifiers of Rate group from external systems. |
| optional, max length 3 months | Interval in which the Rate group was updated. | |
| array of string Activity state | optional | Whether to return only active, only deleted or both records. |
| required | Limitation on the quantity of rate groups returned. |
Response
Property | Type | Contract | Description |
---|---|---|---|
| array of Rate group | required | The filtered rate groups. |
| string | required | Unique identifier of the last and hence oldest rate group returned. This can be used in Limitation in a subsequent request to fetch the next batch of older rate groups. |
Rate Group
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the rate group. |
| string | required | Unique identifier of the Service the rate group belongs to. |
| boolean | required | Whether the rate group is still active. |
| string | required | Creation date and time of the rate group in UTC timezone in ISO 8601 format. |
| string | required | Last update date and time of the rate group in UTC timezone in ISO 8601 format. |
| number | required | Ordering of the rate group. |
| required | All translations of the name. | |
| required | All translations of the short name. | |
| required | All translations of the description. | |
| string | optional, max 255 characters | Identifier of the rate group from external system. |
Last updated