swagger: '2.0'
info:
  version: '2.0'
  title: member-attributes
consumes:
  - application/json
produces:
  - application/json
paths:
  /member-attributes:
    get:
      tags:
        - member-attributes
      description: Get a collection of member attributes.
      operationId: getMemberAttributes
      parameters:
        - name: id
          in: query
          description: The unique numeric ID for identifying the member attribute.
          required: false
          type: integer
          format: int64
        - name: attributeType
          in: query
          description: 'The data type of the member attribute. Available values: DATETIME, FLOAT, INTEGER or STRING.'
          required: false
          type: string
        - name: name
          in: query
          description: The name of the member attribute.
          required: false
          type: string
        - name: description
          in: query
          description: The description of the member attribute.
          required: false
          type: string
        - name: offset
          in: query
          description: 'The position within the resulting dataset where the query begins returning item records. If the offset is "5", the records that returned begin with the sixth record that matches the query parameters. If the offset is "0", the records that are returned begin with the first record that matches the query parameters.'
          required: false
          type: integer
          format: int32
        - name: limit
          in: query
          description: The maximum number of records to return.
          required: false
          type: integer
          format: int32
        - name: fields
          in: query
          description: 'The comma-separated set of properties to be returned. If no properties are specified, all properties are returned.'
          required: false
          type: string
        - name: expand
          in: query
          description: 'The comma-separated set of related resources referenced in the links to be returned. If no related resources are specified, no related resources are returned.'
          required: false
          type: string
        - name: sort
          in: query
          description: 'The comma-separated set of properties which controls the order of the items being listed, prefixed by either (-) to sort by descending order, or optionally (+) to sort by ascending order. For example, sort=name,-d which means, order the items based on the name value in ascending order, then by the id value in descending order.'
          required: false
          type: string
      responses:
        '200':
          description: A collection of member attributes.
          schema:
            $ref: '#/definitions/MemberAttributeCollection'
        '400':
          description: There was a client error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
        '500':
          description: There was a server error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
    post:
      tags:
        - member-attributes
      description: Create a member attribute.
      operationId: createMemberAttribute
      parameters:
        - in: body
          name: MemberAttribute
          description: A member attribute that can be associated with a user or organization.
          required: true
          schema:
            $ref: '#/definitions/MemberAttribute'
      responses:
        '201':
          description: The operation was successful.
        '400':
          description: There was a client error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
        '500':
          description: There was a server error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
  '/member-attributes/{id}':
    get:
      tags:
        - member-attributes
      description: Get a member attribute.
      operationId: getMemberAttributeById
      parameters:
        - name: fields
          in: query
          description: 'The comma-separated set of properties to be returned. If no properties are specified, all properties are returned.'
          required: false
          type: string
        - name: expand
          in: query
          description: 'The comma-separated set of related resources referenced in the links to be returned. If no related resources are specified, no related resources are returned.'
          required: false
          type: string
        - name: sort
          in: query
          description: 'The comma-separated set of properties which controls the order of the items being listed, prefixed by either (-) to sort by descending order, or optionally (+) to sort by ascending order. For example, sort=name,-d which means, order the items based on the name value in ascending order, then by the id value in descending order.'
          required: false
          type: string
      responses:
        '200':
          description: A member attribute that can be associated with a user or organization.
          schema:
            $ref: '#/definitions/MemberAttribute'
        '400':
          description: There was a client error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
        '404':
          description: The resource was not found.
        '500':
          description: There was a server error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
    delete:
      tags:
        - member-attributes
      description: Delete a member attribute.
      operationId: deleteMemberAttributeById
      parameters: []
      responses:
        '204':
          description: The operation was successful.
        '400':
          description: There was a client error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
        '404':
          description: The resource was not found.
        '500':
          description: There was a server error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
    patch:
      tags:
        - member-attributes
      description: Update a member attribute.
      operationId: updateMemberAttributeById
      parameters:
        - in: body
          name: MemberAttribute
          description: A member attribute that can be associated with a user or organization.
          required: true
          schema:
            $ref: '#/definitions/MemberAttribute'
      responses:
        '200':
          description: The operation was successful.
        '400':
          description: There was a client error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
        '404':
          description: The resource was not found.
        '500':
          description: There was a server error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
    parameters:
      - name: id
        in: path
        description: The unique numeric ID for identifying the member attribute.
        required: true
        type: integer
        format: int64
definitions:
  Link:
    type: object
    properties:
      href:
        type: string
        format: uri
        description: The URL of the link.
    description: Links to related resources.
  Error:
    type: object
    properties:
      code:
        type: string
        description: The error message code.
      message:
        type: string
        description: The error message.
      messageKey:
        type: string
        description: The error message key.
      messageArguments:
        type: array
        description: The arguments used to construct the error message.
        items:
          type: object
      correlationId:
        type: string
        description: The unique identifier for the request.
      locale:
        type: string
        description: The locale of the error message.
    description: The error message item model.
  ErrorResponseContainer:
    type: object
    properties:
      requestId:
        type: string
        description: The request identifier.
      errors:
        type: array
        description: The errors.
        items:
          $ref: '#/definitions/Error'
    description: The error message model.
  MemberAttribute:
    type: object
    properties:
      id:
        type: integer
        format: int64
        description: The unique numeric ID for identifying the member attribute.
      attributeType:
        type: string
        description: 'The data type of the member attribute. Available values: DATETIME, FLOAT, INTEGER or STRING.'
      name:
        type: string
        description: The name of the member attribute.
      description:
        type: string
        description: The description of the member attribute.
    description: A member attribute that can be associated with a user or organization.
  MemberAttributeCollection:
    type: object
    properties:
      count:
        type: integer
        format: int64
        description: The total number of items.
      items:
        type: array
        description: The items.
        items:
          $ref: '#/definitions/MemberAttribute'
    description: A collection of member attributes.
