AMCS Group CheckBalance API

The CheckBalance API from AMCS Group — 1 operation(s) for checkbalance.

Specifications

OpenAPI Specification

amcs-group-checkbalance-api-openapi.yml Raw ↑
openapi: 3.0.1
info:
  title: Core AccessGroup CheckBalance API
  version: core
tags:
- name: CheckBalance
paths:
  /integrator/checkBalances:
    get:
      tags:
      - CheckBalance
      summary: Find with Filters
      description: "| Property                                             | Description                                                                        |\r\n| ---------------------------------------------------- | ---------------------------------------------------------------------------------- |\r\n| GUID                                                 | The Site order GUID. Filterable.                                                   |\r\n| CreditBalanceCheck                                   | If they can start a new weighing based on Credit balance                           |"
      operationId: CheckBalance_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[ApiCheckBalanceResource]'
definitions:
  ApiCheckBalanceResource:
    type: object
    properties:
      CreditBalanceCheck:
        type: boolean
      SiteOrderGuid:
        format: uuid
        type: string
        example: 00000000-0000-0000-0000-000000000000
      GUID:
        format: uuid
        type: string
        example: 00000000-0000-0000-0000-000000000000
  ApiResourceErrors:
    type: object
    properties:
      errors:
        type: string
  ApiResourceStatus:
    type: object
    properties:
      id:
        format: int32
        type: integer
      isSuccess:
        type: boolean
  ApiResourceResultCollectionExtra:
    type: object
    properties:
      count:
        format: int32
        type: integer
  ApiResourceResultCollection[ApiCheckBalanceResource]:
    type: object
    properties:
      resource:
        type: array
        items:
          $ref: '#/definitions/ApiCheckBalanceResource'
      extra:
        $ref: '#/definitions/ApiResourceResultCollectionExtra'
      errors:
        $ref: '#/definitions/ApiResourceErrors'
      status:
        $ref: '#/definitions/ApiResourceStatus'