Mews Business segments API
The Business segments API from Mews — 1 operation(s) for business segments.
OpenAPI Specification
openapi: 3.0.4
info:
title: Connector Account notes Business segments API
description: General-purpose API that enables partners of Mews to access data and services in Mews Operations
termsOfService: https://www.mews.com/en/terms-conditions/partners
contact:
name: Partner success
email: partnersuccess@mews.com
version: v1
servers:
- url: https://api.mews.com
tags:
- name: Business segments
paths:
/api/connector/v1/businessSegments/getAll:
post:
tags:
- Business segments
summary: Get all business segments
description: Returns all business segments. This operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/).
operationId: businessSegments_getAll
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BusinessSegmentFilterParameters'
example:
ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
Client: Sample Client 1.0.0
Ids:
- 7760b5cb-a666-41bb-9758-76bf5d1df399
- 54ec08b6-e6fc-48e9-b8ae-02943e0ac693
ServiceIds:
- bd26d8db-86da-4f96-9efc-e5a4654a4a94
- 8c1bd738-a505-4b29-aa71-9ecc2982b843
UpdatedUtc:
StartUtc: '2023-10-01T00:00:00Z'
EndUtc: '2023-10-31T00:00:00Z'
ActivityStates:
- Active
EnterpriseIds:
- 3fa85f64-5717-4562-b3fc-2c963f66afa6
- 4d0201db-36f5-428b-8d11-4f0a65e960cc
Limitation:
Count: 10
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/BusinessSegmentResult'
example:
BusinessSegments:
- Id: 7760b5cb-a666-41bb-9758-76bf5d1df399
ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94
IsActive: true
Name: Business
CreatedUtc: '2023-10-01T00:00:00Z'
UpdatedUtc: '2023-10-01T00:00:00Z'
- Id: 54ec08b6-e6fc-48e9-b8ae-02943e0ac693
ServiceId: 8c1bd738-a505-4b29-aa71-9ecc2982b843
IsActive: true
Name: Leisure
CreatedUtc: '2023-10-01T00:00:00Z'
UpdatedUtc: '2023-10-01T00:00:00Z'
Cursor: 54ec08b6-e6fc-48e9-b8ae-02943e0ac693
'400':
description: 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).
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
'401':
description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
'403':
description: 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.
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
'408':
description: 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](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts)
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
'204':
description: Server has successfully fulfilled the request and there is no additional information to send back.
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
'429':
description: 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](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits).
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
'500':
description: 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](https://github.com/MewsSystems/gitbook-connector-api).
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
components:
schemas:
BusinessSegmentFilterParameters:
title: BusinessSegmentFilterParameters
required:
- AccessToken
- Client
- ClientToken
- Limitation
type: object
properties:
ClientToken:
minLength: 1
type: string
description: Token identifying the client application.
AccessToken:
minLength: 1
type: string
description: Access token of the client application.
Client:
minLength: 1
type: string
description: Name and version of the client application.
Limitation:
allOf:
- $ref: '#/components/schemas/Limitation'
description: Limitation on the quantity of data returned and optional Cursor for the starting point of data.
EnterpriseIds:
maxItems: 1000
minItems: 1
type: array
items:
type: string
format: uuid
description: Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token.
nullable: true
Ids:
maxItems: 1000
minItems: 1
type: array
items:
type: string
format: uuid
description: Unique identifiers of the requested `Business segment`.
nullable: true
ServiceIds:
maxItems: 1000
minItems: 1
type: array
items:
type: string
format: uuid
description: Unique identifiers of the `Services` from which the business segments are requested.
nullable: true
UpdatedUtc:
title: Time interval
allOf:
- $ref: '#/components/schemas/TimeFilterInterval'
description: Interval of `Business segment` last update date and time.
nullable: true
x-max-interval-in-months: 3
ActivityStates:
type: array
items:
$ref: '#/components/schemas/ActivityStates'
description: Whether to return only active, only deleted or both records.
nullable: true
additionalProperties: false
x-schema-id: BusinessSegmentFilterParameters
ConnectorApiExceptionResult:
title: ConnectorApiExceptionResult
type: object
properties:
Message:
type: string
nullable: true
RequestId:
type: string
nullable: true
Details:
nullable: true
additionalProperties: false
x-schema-id: ConnectorApiExceptionResult
BusinessSegmentResult:
title: BusinessSegmentResult
required:
- BusinessSegments
type: object
properties:
BusinessSegments:
type: array
items:
$ref: '#/components/schemas/BusinessSegment'
description: Business segments.
Cursor:
type: string
description: Unique identifier of the last and hence oldest business segment item returned. This can be used in Limitation in a subsequent request to fetch the next batch of older business segment.
format: uuid
nullable: true
additionalProperties: false
x-schema-id: BusinessSegmentResult
ActivityStates:
title: Activity state
enum:
- Deleted
- Active
type: string
description: Activity states used for filtering.
Limitation:
title: Limitation
required:
- Count
type: object
properties:
Count:
type: integer
format: int32
Cursor:
type: string
format: uuid
nullable: true
additionalProperties: false
description: Limitation on the quantity of data returned.
x-schema-id: Limitation
TimeFilterInterval:
title: Time interval
type: object
properties:
StartUtc:
type: string
format: date-time
nullable: true
EndUtc:
type: string
format: date-time
nullable: true
additionalProperties: false
description: "When a time interval is used for **filtering** (for example in parameters such as `CreatedUtc.StartUtc` / `CreatedUtc.EndUtc`), the following rules apply:\r\n\r\n- **Start equals End (equality mode)** \r\n If `StartUtc` and `EndUtc` are exactly the same timestamp, the filter is treated as an equality check for that precise moment in time:\r\n \r\n ```\r\n CreatedUtc == StartUtc\r\n ```\r\n \r\n This does not represent an interval; only records with `CreatedUtc` equal to that exact instant are returned.\r\n\r\n- **Start differs from End (interval mode)** \r\n If `StartUtc` and `EndUtc` are different, the filter is evaluated as a half-open interval:\r\n \r\n ```\r\n StartUtc <= CreatedUtc < EndUtc\r\n ```\r\n \r\n In other words, the start is inclusive and the end is exclusive.\r\n\r\nMake sure your integration takes inclusive Start / exclusive End behavior of time intervals into account so that no records at the boundaries are omitted."
x-schema-id: TimeFilterInterval
BusinessSegment:
title: Business segment
required:
- CreatedUtc
- Id
- IsActive
- Name
- ServiceId
- UpdatedUtc
type: object
properties:
Id:
type: string
description: Unique identifier of the business segment.
format: uuid
ServiceId:
type: string
description: Unique identifier of the `Service`.
format: uuid
IsActive:
type: boolean
description: Whether the business segment is still active.
Name:
minLength: 1
type: string
description: Name of the business segment.
CreatedUtc:
minLength: 1
type: string
description: Creation date and time of the business segment in UTC timezone in ISO 8601 format.
format: date-time
UpdatedUtc:
minLength: 1
type: string
description: Last update date and time of the business segment in UTC timezone in ISO 8601 format.
format: date-time
additionalProperties: false
x-schema-id: BusinessSegment