Get all rate groups
POST /api/connector/v1/rateGroups/getAll
Returns all rate groups, filtered by unique identifiers and other filters. Note this operation uses Pagination and supports Portfolio Access Tokens.
Request Body
Section titled “Request Body ”object
Token identifying the client application.
Access token of the client application.
Name and version of the client application.
Limitation on the quantity of data returned and optional Cursor for the starting point of data.
object
Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token.
Unique identifiers of the Rate group. Required if ServiceIds filter is not provided.
Unique identifiers of the Service. Required if RateGroupIds filter is not provided.
Identifiers of Rate group from external systems.
object
Whether to return only active, only deleted or both records.
Example
{ "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D", "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D", "Client": "Sample Client 1.0.0", "RateGroupIds": [ "6b3f718a-b537-45b0-a8ee-d30897723834" ], "ServiceIds": [ "bd26d8db-86da-4f96-9efc-e5a4654a4a94" ], "ExternalIdentifiers": [ "RG-001" ], "UpdatedUtc": { "StartUtc": "2024-01-27T11:48:57Z", "EndUtc": "2024-02-27T11:48:57Z" }, "ActivityStates": [ "Active" ], "EnterpriseIds": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6", "4d0201db-36f5-428b-8d11-4f0a65e960cc" ], "Limitation": { "Count": 1000, "Cursor": "e7f26210-10e7-462e-9da8-ae8300be8ab7" }}Responses
Section titled “ Responses ”OK
object
The filtered rate groups.
object
Unique identifier of the rate group.
Unique identifier of the Service the rate group belongs to.
Whether the rate group is still active.
Creation date and time of the rate group in UTC timezone in ISO 8601 format.
Last update date and time of the rate group in UTC timezone in ISO 8601 format.
Ordering of the rate group.
All translations of the name.
object
All translations of the short name.
object
All translations of the description.
object
Identifier of the rate group from external system.
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.
Example
{ "RateGroups": [ { "Id": "6b3f718a-b537-45b0-a8ee-d30897723834", "ServiceId": "bd26d8db-86da-4f96-9efc-e5a4654a4a94", "IsActive": true, "CreatedUtc": "2023-01-11T13:32:32Z", "UpdatedUtc": "2023-01-13T15:27:28Z", "Ordering": 0, "Names": { "en-US": "Default group" }, "ShortNames": { "en-US": "Default group" }, "Descriptions": { "en-US": "Default group" }, "ExternalIdentifier": "RG-001" } ], "Cursor": "6b3f718a-b537-45b0-a8ee-d30897723834"}Server has successfully fulfilled the request and there is no additional information to send back.
object
Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).
object
Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
object
Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.
object
Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see Request timeouts
object
Error caused by too many requests sent in a given amount of time. Response contains Retry-After header indicating how long the user agent should wait before making a follow-up request. For more information, see Request limits.
object
Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our documentation repository.