AMCS Group Picture API

openapi: 3.2.0
info:
  description: '# Getting Started


    ## Document Purpose and Scope


    The Scale REST API endpoints are technically described in this document. This document''s goal is to instruct readers on how to interface with the Scale REST API.


    ## Security


    The API uses HTTPS as transport layer for security and uses HTTP/1.1 – RFC 7230 for message syntax and routing.


    There are 2 ways of authenticating in order to access the REST API.


    · Requesting a bearer token from /authTokens using username and password


    · Requesting a session log on from /authTokens using a PAT token


    Authentication using username and password will be phased out after 8.6.


    ## GET /authTokens with username and password direct to the App server


    Before using this method a user must be set up with access right “Can POST, PUT, GET to the REST API”. This can be done from User Management in the Scale UI.


    ### Request format


    The following table specifies the format and parameters for this request.


    | Method | Type | Name | Type |

    | --------- | --------- | ------------------ | ------------------ |

    | GET | Parameter | Username | URI encoded string |

    | Parameter | password | URI encoded string | |


    ### Response format


    The following table specifies the format and parameters for the response.


    | Successful response | Type | |

    | ------------------- | --------- | ---- |

    | Bearer token | text/html | |


    The token returned is then uses as a Bearer token in the subsequent calls to the REST API


    ### Example


    The following shows an example of a request to the authentication endpoint:


    https://{scale-url}/scale/api/authTokens?username=john&password=password


    The username and password in this request may need to be URI encoded.


    The token in the response should be supplied in all subsequent requests in an authorization HTTP header.


    Authorization: Bearer tcpRoNbIKOJZj9Yn0CL2oiX7m04JJmlAllaskd810incqjslasadjzxzza29axb


    Notes:


    · No specific Accept or Content-Type header is required for the authentication endpoint as it will always return text/html as content.


    ## POST /scale/api/authTokens with PAT token


    Before using this method, a user must be set up with:


    · Access right “Can POST, PUT, GET to the REST API”


    · A PAT token


    This can be done from User Management in the Scale UI.


    ### Request format


    The following table specifies the format and parameters for this request.


    | Method | Body |

    | ------ | ------------------------------ |

    | POST | { “privatekey”:”{PAT token}” } |


    ### Response format


    The response passes a Platform.ERP.SessionToken as a cookie.


    This cookie should be included in the subsequent calls to the REST API."'
  title: Scale REST Picture API
  version: '9.1'
servers:
- url: http://{env}-svc-core.amcsplatform.com/scale/api/
tags:
- name: Picture
paths:
  /integrator/pictures:
    post:
      tags:
      - Picture
      summary: Create or update
      description: '| Property | Description | Required |

        |---------------------------------------|-----------------------------------------------|-----------|

        | DateTime | The date and time of the picture. | Yes |

        | Description | The description of the picture. | No |

        | RelatedVehicleReg | The related vehicle reg. | No |

        | Base64Picture | The Base64Picture blob hash of the picture. | Yes |

        | RelatedWeighingGuid | The weighing guid. | No |

        | IsAnpr | The Anpr picture type. | No |

        | CompanyOutletGuid | The CompanyOutlet guid. | No |

        | SubscriberGuid | The Subscriber guid. | Yes |


        ## Extra validations


        | Condition | Error message |

        |-----------|---------------|

        | If RelatedVehicleReg and RelatedWeighingGuid are both null | Either RelatedVehicleReg or RelatedWeighingGuid property must have a value. |

        | If no Weighing is found associated to the ANPR data | Weighing not found for this ANPR data. |

        | If Subscriber isnt subscribed to Outlet | Subscriber isnt subscribed to Outlet. |

        | If no Outlets were found for Subscriber | No Outlets were found for Subscriber. |'
      operationId: Picture_Create
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResourceId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiResourceId'
        required: true
components:
  schemas:
    ApiResourceErrors:
      type: object
      properties:
        errors:
          type: string
    ApiResourceStatus:
      type: object
      properties:
        id:
          format: int32
          type: integer
        isSuccess:
          type: boolean
    ApiResourceId:
      type: object
      properties:
        resource:
          format: int32
          type: integer
        errors:
          $ref: '#/components/schemas/ApiResourceErrors'
        status:
          $ref: '#/components/schemas/ApiResourceStatus'