Decisiv Sublet Case Recipients API

openapi: 3.2.0
info:
  version: 0.48.24
  termsOfService: https://www.decisiv.com/terms-of-use
  contact:
    name: Decisiv Support
    email: support@decisiv.com
    url: https://www.decisiv.com
  title: Service Management Sublet Case Recipients API
  description: The **Decisiv SRM Gateway** `Service Management` module provides the API functionality for managing an asset's case lifecycle from a Service Providers perspective.
  license:
    name: Proprietary
    identifier: proprietary
    url: https://www.decisiv.com/terms-of-use/
servers:
- url: https://srm-api.staging.decisivapps.com
- url: https://srm-api.decisivapps.com
security:
- OAuth2AuthorizationCode: []
  AccessToken: []
- OAuth2Password: []
  AccessToken: []
tags:
- name: Sublet Case Recipients
paths:
  /service_management/{srm_account_id}/v1/sublet_cases/{sublet_case_id}/participants/{participant_id}/recipients:
    get:
      summary: Lists the recipients for a selected sublet case
      tags:
      - Sublet Case Recipients
      parameters:
      - name: srm_account_id
        in: path
        description: The account ID for SRM
        required: true
        schema:
          type: string
      - name: sublet_case_id
        in: path
        schema:
          type: string
          format: uuid
        description: The sublet case UUID
        required: true
      - name: participant_id
        in: path
        schema:
          type: string
          format: uuid
        description: The participant UUID
        required: true
      - name: page[number]
        in: query
        required: false
        schema:
          type: integer
          default: 1
          minimum: 1
        description: Sets the desired `page` when encountering larger result sets
      - name: page[size]
        in: query
        required: false
        schema:
          type: integer
          default: 25
          minimum: 1
        description: Sets the desired maximum number of results per page
      responses:
        '200':
          description: Returns list of recipients for the sublet case
          content:
            application/vnd.api+json:
              example:
                data:
                - id: bd763ee6-b2f2-49fc-a375-7fb5346ee19d
                  type: recipients
                  attributes:
                    name: John Doe
                    phone: '12345678910'
                    email: recipient@email.com
                    first_name: John
                    last_name: Doe
                    communication:
                    - method_type: email
                      value: recipient@email.com
                      notify: true
                    - method_type: mobile
                      value: '12345678910'
                      notify: false
                  relationships:
                    affiliation:
                      data:
                        type: participants
                        id: cb967209-0c68-42cc-ad8d-8413554b507f
                  links:
                    self: https://srm-api.example.com/service_management/ABC-123/v1/sublet_cases/719d44af-b0f5-4e3c-98f7-baa16cedea98/participants/cb967209-0c68-42cc-ad8d-8413554b507f/recipients/bd763ee6-b2f2-49fc-a375-7fb5346ee19d
                meta:
                  record-count: 1
              schema:
                $ref: '#/components/schemas/recipients'
        '400':
          description: This response may occur when an invalid request has been provided to the server.  The request may be corrected by the consumer and resubmitted.
          content:
            application/vnd.api+json:
              example:
                errors:
                - title: Filter not allowed
                  detail: '''{{filter_name}}'' is not allowed. Valid filters: {{filters_list}}'
                  code: decisiv:filters:001
                  status: '400'
                  source:
                    parameter: filter[filter_name]
              schema:
                $ref: '#/components/schemas/errors_response'
        '401':
          description: This response may occur when the access token provided within the Authorization token has expired.
          content:
            application/vnd.api+json:
              example:
                errors:
                - title: Access unauthorized
                  detail: Access unauthorized
                  code: decisiv::access_token:001
                  status: '401'
              schema:
                $ref: '#/components/schemas/errors_response'
        '403':
          description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource.
          content:
            application/vnd.api+json:
              example:
                errors:
                - title: Forbidden
                  detail: User does not have permission to perform this action on the requested resource(s)
                  code: decisiv:access:001
                  status: '403'
              schema:
                $ref: '#/components/schemas/errors_response'
        '404':
          description: This response may occur when the requested resource is not found.
          content:
            application/vnd.api+json:
              example:
                errors:
                - title: Record not found
                  detail: The requested record or one of its relationships could not be found
                  code: '404'
                  status: '404'
              schema:
                $ref: '#/components/schemas/errors_response'
        '424':
          description: This response may occur when there is an unresolved data dependency or configuration required inside of the Decisiv Platform preventing access to the requested action.
          content:
            application/vnd.api+json:
              example:
                errors:
                - title: Failed Dependency
                  detail: Failed Dependency
                  code: '424'
                  status: '424'
              schema:
                $ref: '#/components/schemas/errors_response'
        '504':
          description: This response may occur when there is an unexpected system timeout.
          content:
            application/vnd.api+json:
              example:
                errors:
                - code: '504'
                  detail: Gateway timeout error
                  status: '504'
                  title: Gateway timeout error
              schema:
                $ref: '#/components/schemas/errors_response'
  /service_management/{srm_account_id}/v1/sublet_cases/{sublet_case_id}/participants/{participant_id}/recipients/{id}:
    get:
      summary: List details on a specific recipient
      tags:
      - Sublet Case Recipients
      parameters:
      - name: srm_account_id
        in: path
        description: The account ID for SRM
        required: true
        schema:
          type: string
      - name: sublet_case_id
        in: path
        schema:
          type: string
          format: uuid
        description: The sublet case UUID
        required: true
      - name: participant_id
        in: path
        schema:
          type: string
          format: uuid
        description: The participant UUID
        required: true
      - name: id
        in: path
        schema:
          type: string
          format: uuid
        description: The resource ID
        required: true
      responses:
        '200':
          description: Show details for requested recipient
          content:
            application/vnd.api+json:
              example:
                data:
                  id: bd763ee6-b2f2-49fc-a375-7fb5346ee19d
                  type: recipients
                  attributes:
                    name: John Doe
                    phone: '12345678910'
                    email: recipient@email.com
                    first_name: John
                    last_name: Doe
                    communication:
                    - method_type: email
                      value: recipient@email.com
                      notify: true
                    - method_type: mobile
                      value: '12345678910'
                      notify: false
                  relationships:
                    affiliation:
                      data:
                        type: participants
                        id: cb967209-0c68-42cc-ad8d-8413554b507f
                  links:
                    self: https://srm-api.example.com/service_management/ABC-123/v1/sublet_cases/719d44af-b0f5-4e3c-98f7-baa16cedea98/participants/cb967209-0c68-42cc-ad8d-8413554b507f/recipients/bd763ee6-b2f2-49fc-a375-7fb5346ee19d
              schema:
                $ref: '#/components/schemas/recipient'
        '401':
          description: This response may occur when the access token provided within the Authorization token has expired.
          content:
            application/vnd.api+json:
              example:
                errors:
                - title: Access unauthorized
                  detail: Access unauthorized
                  code: decisiv::access_token:001
                  status: '401'
              schema:
                $ref: '#/components/schemas/errors_response'
        '403':
          description: This response may occur when the authenticated user embedded within the Authorization header does not have access to the requested resource.
          content:
            application/vnd.api+json:
              example:
                errors:
                - title: Forbidden
                  detail: User does not have permission to perform this action on the requested resource(s)
                  code: decisiv:access:001
                  status: '403'
              schema:
                $ref: '#/components/schemas/errors_response'
        '404':
          description: This response may occur when the requested resource is not found.
          content:
            application/vnd.api+json:
              example:
                errors:
                - title: Record not found
                  detail: The requested record or one of its relationships could not be found
                  code: '404'
                  status: '404'
              schema:
                $ref: '#/components/schemas/errors_response'
        '424':
          description: This response may occur when there is an unresolved data dependency or configuration required inside of the Decisiv Platform preventing access to the requested action.
          content:
            application/vnd.api+json:
              example:
                errors:
                - title: Failed Dependency
                  detail: Failed Dependency
                  code: '424'
                  status: '424'
              schema:
                $ref: '#/components/schemas/errors_response'
        '504':
          description: This response may occur when there is an unexpected system timeout.
          content:
            application/vnd.api+json:
              example:
                errors:
                - code: '504'
                  detail: Gateway timeout error
                  status: '504'
                  title: Gateway timeout error
              schema:
                $ref: '#/components/schemas/errors_response'
components:
  schemas:
    recipients:
      type: object
      required:
      - data
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/recipient_properties-data'
        meta:
          type: object
          properties:
            record-count:
              type: integer
              description: Total count across all pages
    recipient:
      type: object
      required:
      - data
      properties:
        data:
          type: object
          description: A participant recipient — the addressable identity used to deliver case notifications. The `type` indicates which underlying record provides the contact details (a directly-attached recipient, a registered contact, an ad-hoc contact, or a service-group contact).
          properties:
            id:
              type: string
              format: uuid
            type:
              type: string
              description: Discriminator for the recipient's underlying source record.
              enum:
              - recipients
              - registered_contacts
              - contacts
              - service_group_contacts
            attributes:
              type: object
              properties:
                name:
                  type: string
                  example: John Doe
                email:
                  type: string
                  example: support@support.com
                phone:
                  type: string
                  example: '12345678910'
                first_name:
                  type: string
                  example: John
                  maxLength: 100
                last_name:
                  type: string
                  example: Doe
                  maxLength: 100
                communication:
                  type: array
                  items:
                    type: object
                    properties:
                      method_type:
                        type: string
                        example: email
                        enum:
                        - email
                        - mobile
                      value:
                        type: string
                        example: 123-456-7890
                        maxLength: 128
                      notify:
                        type: boolean
                        description: Whether to notify via this method
                        example: true
            relationships:
              type: object
              properties:
                affiliation:
                  allOf:
                  - $ref: '#/components/schemas/relationship_object'
                  - description: The affiliated participant.
            links:
              type: object
              properties:
                self:
                  type: string
          required:
          - attributes
          - type
          - id
    error_response:
      type: object
      properties:
        status:
          type: string
        title:
          type: string
        detail:
          type:
          - string
          - 'null'
        code:
          type:
          - string
          - 'null'
        source:
          type: object
          properties:
            parameter:
              type:
              - string
              - 'null'
            pointer:
              type:
              - string
              - 'null'
        links:
          type: object
          description: Links related to this error (e.g. documentation reference).
          additionalProperties:
            type: string
            format: uri
      required:
      - status
      - title
    recipient_properties-data:
      type: object
      description: A participant recipient — the addressable identity used to deliver case notifications. The `type` indicates which underlying record provides the contact details (a directly-attached recipient, a registered contact, an ad-hoc contact, or a service-group contact).
      properties:
        id:
          type: string
          format: uuid
        type:
          type: string
          description: Discriminator for the recipient's underlying source record.
          enum:
          - recipients
          - registered_contacts
          - contacts
          - service_group_contacts
        attributes:
          type: object
          properties:
            name:
              type: string
              example: John Doe
            email:
              type: string
              example: support@support.com
            phone:
              type: string
              example: '12345678910'
            first_name:
              type: string
              example: John
              maxLength: 100
            last_name:
              type: string
              example: Doe
              maxLength: 100
            communication:
              type: array
              items:
                type: object
                properties:
                  method_type:
                    type: string
                    example: email
                    enum:
                    - email
                    - mobile
                  value:
                    type: string
                    example: 123-456-7890
                    maxLength: 128
                  notify:
                    type: boolean
                    description: Whether to notify via this method
                    example: true
        relationships:
          type: object
          properties:
            affiliation:
              allOf:
              - $ref: '#/components/schemas/relationship_object'
              - description: The affiliated participant.
        links:
          type: object
          properties:
            self:
              type: string
      required:
      - attributes
      - type
      - id
    relationship_object:
      type: object
      properties:
        data:
          type:
          - object
          - 'null'
          properties:
            id:
              type: string
            type:
              type: string
          required:
          - id
          - type
      required:
      - data
    errors_response:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/error_response'
      required:
      - errors
  securitySchemes:
    AccessToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
    OAuth2AuthorizationCode:
      type: oauth2
      description: OAuth 2.0 Authorization Code flow. This is the required flow for new integrations. See https://api-docs.decisiv.net/docs/api/oauth/
      flows:
        authorizationCode:
          authorizationUrl: https://login.decisiv.net/auth/api_gateway
          tokenUrl: https://login.decisiv.net/oauth/token
          refreshUrl: https://login.decisiv.net/oauth/token
          scopes: {}
    OAuth2Password:
      type: oauth2
      description: '**Deprecated.** OAuth 2.0 Password flow. New integrations must use the Authorization Code flow (`OAuth2AuthorizationCode`); this flow remains available only during the migration window and will be removed in a future release. See https://api-docs.decisiv.net/docs/api/oauth/'
      flows:
        password:
          tokenUrl: https://login.decisiv.net/oauth/token
          scopes: {}