openapi: 3.2.0
info:
  description: Welcome to the Rocket Matter API.
  version: '2.0'
  title: Rocket Matter Mobile API
  termsOfService: www.rocketmatter.com
  contact:
    email: developer@rocketmatter.com
  license:
    name: Rocket Matter
    url: www.rocketmatter.com
  x-logo:
    url: https://support.rocketmatter.com/wp-content/themes/rm-support/img/rm-logo.png
servers:
- url: https://<DOMAIN>/<INSTALL>/API_V2
tags:
- name: Mobile
  description: Manage mobile device-specific actions.
paths:
  /Mobile.svc/json/SaveUserToken:
    post:
      tags:
      - Mobile
      description: Saves the user token from a mobile device with a unique DeviceId generated by the mobile app and push notification Token generated from the phone.
      operationId: SaveUserToken
      responses:
        '200':
          description: Successfully processed request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SaveUserTokenResponse'
        '400':
          description: Internal server error
        '401':
          description: Unauthorized
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SaveUserTokenRequest'
        required: true
      summary: Save user token
      x-summary-source: derived
  /Mobile.svc/json/GetUserNotifications:
    post:
      tags:
      - Mobile
      description: Gets push notifications for the phone for the specified DeviceId.
      operationId: GetUserNotifications
      responses:
        '200':
          description: Successfully processed request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetUserNotificationsResponse'
        '400':
          description: Internal server error
        '401':
          description: Unauthorized
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetUserNotificationsRequest'
        required: true
      summary: Get user notifications
      x-summary-source: derived
  /Mobile.svc/json/DeleteUserNotification:
    post:
      tags:
      - Mobile
      description: Deletes a push notification by Id
      operationId: DeleteUserNotification
      responses:
        '200':
          description: Successfully processed request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteUserNotificationResponse'
        '400':
          description: Internal server error
        '401':
          description: Unauthorized
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteUserNotificationRequest'
        required: true
      summary: Delete user notification
      x-summary-source: derived
  /Mobile.svc/json/ReadUserNotification:
    post:
      tags:
      - Mobile
      description: Sets a notification's state to 'read'.
      operationId: ReadUserNotification
      responses:
        '200':
          description: Successfully processed request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteUserNotificationResponse'
        '400':
          description: Internal server error
        '401':
          description: Unauthorized
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteUserNotificationRequest'
        required: true
      summary: Read user notification
      x-summary-source: derived
  /Mobile.svc/json/SetUserMobilePin:
    post:
      tags:
      - Mobile
      description: Saves the Pin for the specified DeviceId.
      operationId: SetUserMobilePin
      responses:
        '200':
          description: Successfully processed request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SetUserMobilePinResponse'
        '400':
          description: Internal server error
        '401':
          description: Unauthorized
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetUserMobilePinRequest'
        required: true
      summary: Set user mobile pin
      x-summary-source: derived
  /Mobile.svc/json/GetAuthenticationToken:
    post:
      tags:
      - Mobile
      description: Generates a unique authentication token for the specified DeviceId, this token can be uses to get a new AccessToken and RefreshToken at any time and it does not expire.
      operationId: GetAuthenticationToken
      responses:
        '200':
          description: Successfully processed request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAuthenticationTokenResponse'
        '400':
          description: Internal server error
        '401':
          description: Unauthorized
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetAuthenticationTokenRequest'
        required: true
      summary: Get authentication token
      x-summary-source: derived
  /Mobile.svc/json/ClearAuthenticationToken:
    post:
      tags:
      - Mobile
      description: Removes the authentication token associated with the DeviceId, this is used for cleanup purposes.
      operationId: ClearAuthenticationToken
      responses:
        '200':
          description: Successfully processed request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAuthenticationTokenResponse'
        '400':
          description: Internal server error
        '401':
          description: Unauthorized
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetAuthenticationTokenRequest'
        required: true
      summary: Clear authentication token
      x-summary-source: derived
components:
  schemas:
    DeleteUserNotificationRequest:
      type: object
      properties:
        NotificationId:
          type: string
    UserMobileNotification:
      type: object
      properties:
        Title:
          type: string
        Message:
          type: string
        DateSent:
          type: string
          format: date-time
        MatterId:
          type: integer
          format: int32
        EntityNameId:
          type: integer
          format: int32
        EntityId:
          type: string
        MatterName:
          type: string
        IsRead:
          type: boolean
        Id:
          type: string
    CharacterValidationRule:
      type: object
      properties:
        ShouldMatch:
          type: boolean
        Message:
          type: string
        Regex:
          type: string
    SetUserMobilePinRequest:
      type: object
      properties:
        DeviceId:
          type: string
        Pin:
          type: string
    GetUserNotificationsRequest:
      type: object
      properties:
        DeviceId:
          type: string
        GetCount:
          type: boolean
        Offset:
          type: integer
          format: int32
        Fetch:
          type: integer
          format: int32
    GetAuthenticationTokenResponse:
      type: object
      properties:
        AuthenticationToken:
          type: string
        Success:
          type: boolean
        Message:
          type: string
        ErrorMessage:
          type: string
        ErrorNumber:
          type: integer
          format: int32
        FailedValidations:
          type: array
          items:
            $ref: '#/components/schemas/ValidationResult'
        Errors:
          type: array
          items:
            type: string
    ValidationResult:
      type: object
      properties:
        MinValue:
          type: boolean
        MaxValue:
          type: boolean
        MinLength:
          type: boolean
        MaxLength:
          type: boolean
        Required:
          type: boolean
        PropertyDisplayName:
          type: string
        Precision:
          type: boolean
        ValueEntered:
          type: object
        Name:
          type: string
        ObjectName:
          type: string
        ExternalID:
          type: string
        MinValueMessage:
          type: string
        MaxValueMessage:
          type: string
        MinLengthMessage:
          type: string
        MaxLengthMessage:
          type: string
        RequiredMessage:
          type: string
        RequiredPrecisionMessage:
          type: string
        BaseFailureMessage:
          type: string
        FailedValidationMessages:
          type: array
          items:
            type: string
        FailedCharacterValidations:
          type: array
          items:
            $ref: '#/components/schemas/CharacterValidationRule'
        IsValid:
          type: boolean
    SaveUserTokenResponse:
      type: object
      properties:
        Success:
          type: boolean
        Message:
          type: string
        ErrorMessage:
          type: string
        ErrorNumber:
          type: integer
          format: int32
        FailedValidations:
          type: array
          items:
            $ref: '#/components/schemas/ValidationResult'
        Errors:
          type: array
          items:
            type: string
    SaveUserTokenRequest:
      type: object
      properties:
        Token:
          type: string
        DeviceId:
          type: string
    DeleteUserNotificationResponse:
      type: object
      properties:
        Success:
          type: boolean
        Message:
          type: string
        ErrorMessage:
          type: string
        ErrorNumber:
          type: integer
          format: int32
        FailedValidations:
          type: array
          items:
            $ref: '#/components/schemas/ValidationResult'
        Errors:
          type: array
          items:
            type: string
    GetUserNotificationsResponse:
      type: object
      properties:
        Count:
          type: integer
          format: int32
        Notifications:
          type: array
          items:
            $ref: '#/components/schemas/UserMobileNotification'
        Success:
          type: boolean
        Message:
          type: string
        ErrorMessage:
          type: string
        ErrorNumber:
          type: integer
          format: int32
        FailedValidations:
          type: array
          items:
            $ref: '#/components/schemas/ValidationResult'
        Errors:
          type: array
          items:
            type: string
    SetUserMobilePinResponse:
      type: object
      properties:
        Success:
          type: boolean
        Message:
          type: string
        ErrorMessage:
          type: string
        ErrorNumber:
          type: integer
          format: int32
        FailedValidations:
          type: array
          items:
            $ref: '#/components/schemas/ValidationResult'
        Errors:
          type: array
          items:
            type: string
    GetAuthenticationTokenRequest:
      type: object
      properties:
        DeviceId:
          type: string