AMCS Group CustomerSite API
The CustomerSite API from AMCS Group — 1 operation(s) for customersite.
OpenAPI Specification
openapi: 3.0.1
info:
title: Core AccessGroup CustomerSite API
version: core
tags:
- name: CustomerSite
paths:
/visionai/api/integrator/customerSites:
post:
tags:
- CustomerSite
summary: Create or Update a Customer Site
description: "# Create or Update a Customer Site\r\n\r\n| Parameter | Type | Description |\r\n| -------------------| -------- | ------------------------------------------------------------------------- |\r\n| CustomerSiteId | GUID | ID of the Customer Site |\r\n| Name | string | Display name of the Customer Site (Customer Name) |\r\n| Country | string | Address part |\r\n| City | string | Address part |\r\n| Street | string | Address part |\r\n| Address1 | string | Address part |\r\n| Address2 | string | Address part |\r\n| Address3 | string | Address part |\r\n| Address4 | string | Additional address part |\r\n| Address5 | string | Additional address part |\r\n| PostalCode | string | Address part |\r\n| HouseNumber | string | Address part |\r\n| Latitude | double | Geographic coordinate |\r\n| Longitude | double | Geographic coordinate |\r\n| OutletId | GUID | ID of the Company Outlet associated with the Customer Site |\r\n| IsDeleted | bool | Indicates if the Customer Site is no longer in use |\r\n| SiteType | string | Type of the site |\r\n| CustomerType | string | Type of the customer |\r\n\r\n## Sample API Requests\r\n\r\n```\r\n{\r\n \"CustomerSiteId\": \"B3E43C4D-BC76-4E59-9E2E-25BC33EA2EC4\",\r\n \"Name\": \"Alterwerth Group\",\r\n \"Country\": \"United States\",\r\n \"City\": \"Upper Marlboro\",\r\n \"Street\": \"Trent Oval\",\r\n \"PostalCode\": \"MD 20792\",\r\n \"HouseNumber\": \"1762\",\r\n \"Address1\": \"Building A\",\r\n \"Address2\": \"Suite 5\",\r\n \"Address3\": \"Near Landmark Mall\",\r\n \"Address4\": \"PO Box 123\",\r\n \"Address5\": \"Additional Info\",\r\n \"Latitude\": 38.82000560748161,\r\n \"Longitude\": -76.75000011205616,\r\n \"OutletId\": \"2FAD788D-A748-4520-9120-923DA1E42942\",\r\n \"IsDeleted\": false,\r\n \"SiteType\": \"\",\r\n \"CustomerType\": \"\"\r\n}\r\n```\r\n"
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AMCS.IoT.Contamination.Api.Integrator.CustomerSite.ApiCustomerAddress'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResourceId'
'400':
$ref: '#/components/responses/BadRequest'
'401':
description: Unauthorized
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/InternalServerError'
'501':
$ref: '#/components/responses/NotImplemented'
'502':
$ref: '#/components/responses/BadGateway'
'503':
$ref: '#/components/responses/ServiceUnavailable'
'504':
$ref: '#/components/responses/GatewayTimeout'
components:
responses:
GatewayTimeout:
description: Gateway Timeout - The server took too long to respond.
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: The request timed out. Please try again later.
additionalProperties: false
Forbidden:
description: Forbidden - Access denied.
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: You do not have permission to access this resource.
additionalProperties: false
NotImplemented:
description: This feature is not implemented.
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: This feature is not implemented.
additionalProperties: false
NotFound:
description: Not Found - The requested resource was not found.
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: The requested resource was not found.
additionalProperties: false
InternalServerError:
description: Supplied properties are not valid, please try again with proper request.
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: Supplied properties are not valid, please try again with proper request.
additionalProperties: false
BadGateway:
description: Bad Gateway - The upstream server returned an invalid response.
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: Temporary issue with the server. Please try again later.
additionalProperties: false
BadRequest:
description: Bad Request - Invalid input parameters.
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: Invalid request. Please check your input parameters.
additionalProperties: false
ServiceUnavailable:
description: Service Unavailable - The server is currently unavailable.
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: Service is currently unavailable. Please try again later.
additionalProperties: false
schemas:
ApiResourceId:
type: object
properties:
errors:
$ref: '#/components/schemas/ApiResourceErrors'
status:
$ref: '#/components/schemas/ApiResourceStatus'
resource:
type: guid
additionalProperties: false
AMCS.IoT.Contamination.Api.Integrator.CustomerSite.ApiCustomerAddress:
type: object
properties:
customerSiteId:
type: string
format: uuid
name:
type: string
nullable: true
postalCode:
type: string
nullable: true
houseNumber:
type: string
nullable: true
address1:
type: string
nullable: true
address2:
type: string
nullable: true
address3:
type: string
nullable: true
address4:
type: string
nullable: true
address5:
type: string
nullable: true
latitude:
type: number
format: double
nullable: true
longitude:
type: number
format: double
nullable: true
outletId:
type: string
format: uuid
isDeleted:
type: boolean
siteType:
type: string
nullable: true
customerType:
type: string
nullable: true
additionalProperties: false
ApiResourceErrors:
type: object
properties:
errors:
type: string
nullable: true
additionalProperties: false
ApiResourceStatus:
type: object
properties:
id:
type: integer
format: int32
nullable: true
isSuccess:
type: boolean
additionalProperties: false