openapi: 3.2.0
info:
  title: Lone Wolf Classifications API
  version: '1.0'
  description: 'Operations tagged Classifications across 2 of this provider''s published API definitions: lone-wolf-back-office-online-api-openapi.yml, lone-wolf-wolfconnect-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.lwolf.com/backoffice
- url: https://api.globalwolfweb.com
  description: Production
- url: https://api-sb.globalwolfweb.com
  description: Test
tags:
- name: Classifications
  description: Classifications relate to the commission structure of a transaction.
paths:
  /v1/classifications:
    get:
      tags:
      - Classifications
      summary: Get Classifications
      operationId: get-v1-classifications
      responses:
        '200':
          description: Request succeeded.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Classification'
              example:
              - id: string
                createdTimestamp: string
                modifiedTimestamp: string
                name: string
                code: string
                endCount: 0
                endTypeCode: B
                inactiveDate: string
        '400':
          description: Invalid request. See response body for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              example:
                id: string
                code: 0
                message: string
                details:
                - string
        '401':
          description: Unauthorized. See response body for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              example:
                id: string
                code: 0
                message: string
                details:
                - string
        '403':
          description: Permission denied. See response body for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              example:
                id: string
                code: 0
                message: string
                details:
                - string
    servers:
    - url: https://api.lwolf.com/backoffice
  /v1/classifications/{classificationId}:
    get:
      tags:
      - Classifications
      summary: Get Classification
      operationId: get-v1-classifications-classificationid
      parameters:
      - name: classificationId
        in: path
        description: The id of the classification.
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Request succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Classification'
              example:
                id: string
                createdTimestamp: string
                modifiedTimestamp: string
                name: string
                code: string
                endCount: 0
                endTypeCode: B
                inactiveDate: string
        '400':
          description: Invalid request. See response body for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              example:
                id: string
                code: 0
                message: string
                details:
                - string
        '401':
          description: Unauthorized. See response body for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              example:
                id: string
                code: 0
                message: string
                details:
                - string
        '403':
          description: Permission denied. See response body for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              example:
                id: string
                code: 0
                message: string
                details:
                - string
        '404':
          description: Not found. See response body for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              example:
                id: string
                code: 0
                message: string
                details:
                - string
    servers:
    - url: https://api.lwolf.com/backoffice
  /wolfconnect/classifications/v1/:
    get:
      tags:
      - Classifications
      summary: Retrieve the list of all Classifications
      operationId: getClassifications
      description: All of the classifications that are configured for the Client Code used during the authentication process will be returned. The classifications returned where LWCompanyCode is blank are for offices that are not synced with brokerWOLF.
      responses:
        '200':
          description: A collection of Classification objects.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Classification_2'
      security:
      - LoneWolfToken: []
    servers:
    - url: https://api.globalwolfweb.com
      description: Production
    - url: https://api-sb.globalwolfweb.com
      description: Test
components:
  schemas:
    ApiError:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for the error.
          readOnly: true
        code:
          type: integer
          description: A code used to help identify the type of error. This is typically set to the same value as the http status code.
          format: int32
          readOnly: true
        message:
          type: string
          description: A summary or short message describing the error.
          readOnly: true
        details:
          type:
          - array
          - 'null'
          items:
            type: string
          description: A list of more detailed errors messages.
          readOnly: true
      additionalProperties: false
    Classification:
      required:
      - name
      - code
      - endCount
      - endTypeCode
      type: object
      properties:
        id:
          type: string
          description: The unique id.
          format: uuid
        createdTimestamp:
          type:
          - string
          - 'null'
          description: The date and time of creation in UTC time.
          format: date-time
        modifiedTimestamp:
          type:
          - string
          - 'null'
          description: The date and time last modification in UTC time.
          format: date-time
        name:
          type: string
          description: The name of the classification.
        code:
          type: string
          description: The code for the classification.
        endCount:
          maximum: 2
          minimum: 0
          type: number
          description: The total number of ends or sides this classification represents. This value will be either 0, 1 or 2.
          format: double
        endTypeCode:
          enum:
          - B
          - D
          - M
          - S
          - X
          type: string
          description: The code representing the end type or side for the classification.
        inactiveDate:
          type:
          - string
          - 'null'
          description: The date the classification was no longer active.
          format: date
      additionalProperties: false
      description: The classification for a transaction.
    Classification_2:
      type: object
      properties:
        Id:
          type: string
          readOnly: true
          description: The Lone Wolf Id of the classification.
        LWCompanyCode:
          type: string
          readOnly: true
          description: The Lone Wolf Company Code. This is the code used by a brokerWOLF installation. It will be blank for offices that are not synced with brokerWOLF.
        Code:
          type: string
          readOnly: true
          description: A code for this classification. This must be unique within an LWCompanyCode.
        Name:
          type: string
          readOnly: true
          description: The name of the classification (Listing, Selling, Agent Double Ender, etc).
        EndCount:
          type: number
          readOnly: true
          description: The end count for the classification. For instance, if this is an Agent Double Ender, the end count would be 2.0. If it's a Listing classification, the end count would be 1.0.
        InactiveDate:
          type:
          - string
          - 'null'
          format: date
          readOnly: true
          description: The date the classification became inactive. (Nullable)
  securitySchemes:
    LoneWolfToken:
      type: apiKey
      in: header
      name: Authorization
      description: 'Custom HMAC-signed authorization scheme used when calling resources that access your actual data:


        ```

        Authorization: LoneWolfToken [API Token]:[Client Code]:[Signature]:[Date]

        ```


        A `Content-MD5` header is also required on every request (base 64 encoded MD5 hash of the request body, or of an empty string for requests without a body: `1B2M2Y8AsgTpgAmY7PhCfg==`).


        The signature is the HMACSHA256 hash (seeded with your secret key) of `[HTTP Method]:[Resource URI]:[Date]:[Content-MD5]`. HMACSHA384 and HMACSHA512 are also supported by appending the algorithm to the scheme (e.g. `LoneWolfToken-HMACSHA512`).


        See the Authentication, Creating a Request, and Creating the Signature sections of the introduction for full details, date format, and worked examples. A separate `LoneWolfKey` scheme exists for resources that deal with your API account; there is never a scenario where you would send more than one type of authorization scheme.'
x-refined-from:
- lone-wolf-back-office-online-api-openapi.yml
- lone-wolf-wolfconnect-api-openapi.yml
x-topics:
- title: Overview
  content:
    $ref: ./docs/authentisign-overview.md
- title: Getting started
  content:
    $ref: ./docs/getting-started.md
- title: Authentication Token
  content:
    $ref: ./docs/authentication.md
- title: HTTP Request
  content:
    $ref: ./docs/http-request.md