AMCS Group WeighingType API

The WeighingType API from AMCS Group — 4 operation(s) for weighingtype.

Specifications

OpenAPI Specification

amcs-group-weighingtype-api-openapi.yml Raw ↑
openapi: 3.0.1
info:
  title: Core AccessGroup WeighingType API
  version: core
tags:
- name: WeighingType
paths:
  /lists/weighingTypes/{guid}:
    get:
      tags:
      - WeighingType
      summary: Find with GUID
      description: "| Property                  | Description                                                           |\r\n| ------------------------- | --------------------------------------------------------------------- |\r\n| GUID                      | The GUID associated to the weighing type                              |\r\n| Description               | The description of the weighing type                                  |"
      operationId: WeighingType_Get
      parameters:
      - name: guid
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: udf
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResourceResultEntity[ApiIntegratorWeighingTypeResource]'
  /lists/weighingTypes:
    get:
      tags:
      - WeighingType
      summary: Find with Filters
      description: "| Property                  | Description                                                           |\r\n| ------------------------- | --------------------------------------------------------------------- |\r\n| GUID                      | The GUID associated to the weighing type                              |\r\n| Description               | The description of the weighing type                                  |"
      operationId: WeighingType_GetCollection
      parameters:
      - name: filter
        in: query
        schema:
          type: string
      - name: max
        in: query
        schema:
          type: integer
          format: int32
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: includeCount
        in: query
        schema:
          type: boolean
      - name: udf
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResourceResultCollection[ApiIntegratorWeighingTypeResource]'
  /integrator/lists/weighingTypes/{id}:
    get:
      tags:
      - WeighingType
      summary: Find with GUID
      description: "| Property                  | Description\t\t\t\t\t\t\t\t\t\t\t|\r\n| ------------------------- | ----------------------------------------------------- |\r\n| GUID                      | The GUID associated to the weighing type\t\t\t\t|\r\n| Description               | The description of the weighing type\t\t\t\t\t|\r\n\t\t\t\t   "
      operationId: WeighingType_Get
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: id
        in: path
        required: true
        type: string
        format: uuid
      - name: links
        in: query
        required: false
        type: string
      - name: include
        in: query
        required: false
        type: string
      - name: expand
        in: query
        required: false
        type: string
      - name: udf
        in: query
        required: false
        type: string
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ApiResourceResultEntity[ApiWeighingTypeResource]'
  /integrator/lists/weighingTypes:
    get:
      tags:
      - WeighingType
      summary: Find with Filters
      description: "| Property                  | Description\t\t\t\t\t\t\t\t\t\t\t|\r\n| ------------------------- | ----------------------------------------------------- |\r\n| GUID                      | The GUID associated to the weighing type\t\t\t\t|\r\n| Description               | The description of the weighing type\t\t\t\t\t|\r\n\t\t\t\t   "
      operationId: WeighingType_GetCollection
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - name: filter
        in: query
        required: false
        type: string
      - name: search
        in: query
        required: false
        type: string
      - name: order
        in: query
        required: false
        type: string
      - name: max
        in: query
        required: false
        type: integer
        format: int32
      - name: page
        in: query
        required: false
        type: integer
        format: int32
      - name: includeCount
        in: query
        required: false
        type: boolean
      - name: includeDeleted
        in: query
        required: false
        type: boolean
      - name: links
        in: query
        required: false
        type: string
      - name: udf
        in: query
        required: false
        type: string
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ApiResourceResultCollection[ApiWeighingTypeResource]'
components:
  schemas:
    ApiResourceErrors:
      type: object
      properties:
        errors:
          type: string
    ApiIntegratorWeighingTypeResource:
      type: object
      properties:
        Description:
          type: string
        GUID:
          type: string
          format: uuid
          example: 00000000-0000-0000-0000-000000000000
    ApiResourceResultEntity[ApiIntegratorWeighingTypeResource]:
      type: object
      properties:
        resource:
          $ref: '#/components/schemas/ApiIntegratorWeighingTypeResource'
        links:
          $ref: '#/components/schemas/ApiResourceResultEntityLinks'
        extra:
          $ref: '#/components/schemas/ApiResourceResultEntityExtra'
        errors:
          $ref: '#/components/schemas/ApiResourceErrors'
        status:
          $ref: '#/components/schemas/ApiResourceStatus'
    ApiResourceResultCollectionExtra:
      type: object
      properties:
        count:
          type: integer
          format: int32
    ApiResourceResultCollection[ApiIntegratorWeighingTypeResource]:
      type: object
      properties:
        resource:
          type: array
          items:
            $ref: '#/components/schemas/ApiIntegratorWeighingTypeResource'
        extra:
          $ref: '#/components/schemas/ApiResourceResultCollectionExtra'
        errors:
          $ref: '#/components/schemas/ApiResourceErrors'
        status:
          $ref: '#/components/schemas/ApiResourceStatus'
    ApiResourceResultEntityExtra:
      type: object
      properties:
        expand:
          type: object
          additionalProperties:
            type: object
            additionalProperties:
              type: object
        include:
          type: object
          additionalProperties:
            type: array
            items:
              type: object
              additionalProperties:
                type: object
    ApiResourceResultEntityLinks:
      type: object
      properties:
        self:
          type: string
        associations:
          type: array
          items:
            type: string
        expand:
          type: array
          items:
            type: string
        operations:
          type: array
          items:
            type: string
    ApiResourceStatus:
      type: object
      properties:
        id:
          type: integer
          format: int32
        isSuccess:
          type: boolean
definitions:
  ApiResourceResultEntity[ApiWeighingTypeResource]:
    type: object
    properties:
      resource:
        $ref: '#/definitions/ApiWeighingTypeResource'
      links:
        $ref: '#/definitions/ApiResourceResultEntityLinks'
      extra:
        $ref: '#/definitions/ApiResourceResultEntityExtra'
      errors:
        $ref: '#/definitions/ApiResourceErrors'
      status:
        $ref: '#/definitions/ApiResourceStatus'
  ApiResourceErrors:
    type: object
    properties:
      errors:
        type: string
  ApiResourceResultCollection[ApiWeighingTypeResource]:
    type: object
    properties:
      resource:
        type: array
        items:
          $ref: '#/definitions/ApiWeighingTypeResource'
      extra:
        $ref: '#/definitions/ApiResourceResultCollectionExtra'
      errors:
        $ref: '#/definitions/ApiResourceErrors'
      status:
        $ref: '#/definitions/ApiResourceStatus'
  ApiResourceStatus:
    type: object
    properties:
      id:
        format: int32
        type: integer
      isSuccess:
        type: boolean
  ApiResourceResultCollectionExtra:
    type: object
    properties:
      count:
        format: int32
        type: integer
  ApiResourceResultEntityExtra:
    type: object
    properties:
      expand:
        type: object
        additionalProperties:
          type: object
          additionalProperties:
            type: object
      include:
        type: object
        additionalProperties:
          type: array
          items:
            type: object
            additionalProperties:
              type: object
  ApiWeighingTypeResource:
    type: object
    properties:
      Description:
        type: string
      GUID:
        format: uuid
        type: string
        example: 00000000-0000-0000-0000-000000000000
  ApiResourceResultEntityLinks:
    type: object
    properties:
      self:
        type: string
      associations:
        type: array
        items:
          type: string
      expand:
        type: array
        items:
          type: string
      operations:
        type: array
        items:
          type: string