AMCS Group Subscriber API
The Subscriber API from AMCS Group — 2 operation(s) for subscriber.
OpenAPI Specification
openapi: 3.0.1
info:
title: Core AccessGroup Subscriber API
version: core
tags:
- name: Subscriber
paths:
/integrator/subscribers/{id}:
get:
tags:
- Subscriber
summary: Find with GUID
description: "| Property | Description |\r\n| ----------------------------------------------------- | -------------------------------------------------------------- |\r\n| Name | The name of the Subscriber |\r\n| CompanyOutlets[] | The company outlets associated with the subscriber |\r\n| CompanyOutlets[].SubscriberOutletListItem | The SubscriberOutletListItem of the outlets for the subscriber |\r\n| CompanyOutlets[].SubscriberOutletListItem.Description | The company outlet description |\r\n| CompanyOutlets[].SubscriberOutletListItem.AbbreviatedDescription | The company outlet abbreviated description |\r\n| CompanyOutlets[].SubscriberOutletListItem.Guid | The company Outlet Guid |\r\n| RelatedSubscriberOutletGuid\t\t\t\t\t\t\t| The Related Subscriber Outlet Guid\t\t\t\t\t\t\t |\r\n| GUID | The Subscriber Guid |"
operationId: Subscriber_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[ApiSubscriberResource]'
put:
tags:
- Subscriber
summary: Partial update
description: "| Property | Description | Required |\r\n|-------------------------------------------------------|------------------------------------------------------------------------|----------|\r\n| Name | The name of the Subscriber | No |\r\n| CompanyOutlets[] | The company outlets associated with the subscriber | Yes |\r\n| CompanyOutlets[].SubscriberOutletListItem | The SubscriberOutletListItem of the outlets for the subscriber | Yes |\r\n| CompanyOutlets[].SubscriberOutletListItem.Description | The company outlet description | No |\r\n| CompanyOutlets[].SubscriberOutletListItem.Guid | The company Outlet Guid | Yes |\r\n| RelatedSubscriberOutletGuid\t\t\t\t\t\t\t| The Related Subscriber Outlet Guid, required if it needs to be updated | No |\r\n| GUID | The Subscriber Guid | No |"
operationId: Subscriber_Update
consumes:
- application/json
produces:
- application/json
parameters:
- name: id
in: path
required: true
type: string
format: uuid
- in: body
required: true
schema:
$ref: '#/definitions/ApiResourceId'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ApiResourceId'
/integrator/subscribers:
get:
tags:
- Subscriber
summary: Find with Filters
description: "| Property | Description |\r\n| ----------------------------------------------------- | -------------------------------------------------------------- |\r\n| Name | The name of the Subscriber |\r\n| CompanyOutlets[] | The company outlets associated with the subscriber |\r\n| CompanyOutlets[].SubscriberOutletListItem | The SubscriberOutletListItem of the outlets for the subscriber |\r\n| CompanyOutlets[].SubscriberOutletListItem.Description | The company outlet description |\r\n| CompanyOutlets[].SubscriberOutletListItem.AbbreviatedDescription | The company outlet abbreviated description |\r\n| CompanyOutlets[].SubscriberOutletListItem.Guid | The company Outlet Guid |\r\n| RelatedSubscriberOutletGuid\t\t\t\t\t\t\t| The Related Subscriber Outlet Guid\t\t\t\t\t\t\t |\r\n| GUID | The Subscriber Guid |"
operationId: Subscriber_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[ApiSubscriberResource]'
post:
tags:
- Subscriber
summary: Create or update
description: "\r\n\r\n# Subscribers\r\n\r\n| Property | Description | Required |\r\n|-------------------------------------------------------|----------------------------------------------------------------|----------|\r\n| Name | The name of the Subscriber | Yes |\r\n| CompanyOutlets[] | The company outlets associated with the subscriber | Yes |\r\n| CompanyOutlets[].SubscriberOutletListItem | The SubscriberOutletListItem of the outlets for the subscriber | Yes |\r\n| CompanyOutlets[].SubscriberOutletListItem.Description | The company outlet description | No |\r\n| CompanyOutlets[].SubscriberOutletListItem.Guid | The company Outlet Guid | Yes |\r\n| RelatedSubscriberOutletGuid\t\t\t\t\t\t\t| The Related Subscriber Outlet Guid\t\t\t\t\t\t\t | No |\r\n| GUID | The Subscriber Guid | No |"
operationId: Subscriber_Create
consumes:
- application/json
produces:
- application/json
parameters:
- in: body
required: true
schema:
$ref: '#/definitions/ApiResourceId'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ApiResourceId'
definitions:
ApiResourceResultEntity[ApiSubscriberResource]:
type: object
properties:
resource:
$ref: '#/definitions/ApiSubscriberResource'
links:
$ref: '#/definitions/ApiResourceResultEntityLinks'
extra:
$ref: '#/definitions/ApiResourceResultEntityExtra'
errors:
$ref: '#/definitions/ApiResourceErrors'
status:
$ref: '#/definitions/ApiResourceStatus'
ApiResourceErrors:
type: object
properties:
errors:
type: string
ApiResourceResultCollection[ApiSubscriberResource]:
type: object
properties:
resource:
type: array
items:
$ref: '#/definitions/ApiSubscriberResource'
extra:
$ref: '#/definitions/ApiResourceResultCollectionExtra'
errors:
$ref: '#/definitions/ApiResourceErrors'
status:
$ref: '#/definitions/ApiResourceStatus'
ApiResourceId:
type: object
properties:
resource:
format: int32
type: integer
errors:
$ref: '#/definitions/ApiResourceErrors'
status:
$ref: '#/definitions/ApiResourceStatus'
ApiSubscriberCompanyOutletResource:
type: object
properties:
SubscriberOutletListItem:
$ref: '#/definitions/ApiIntegratorListItemResource'
RelatedSubscriberOutletGuid:
format: uuid
type: string
example: 00000000-0000-0000-0000-000000000000
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
ApiIntegratorListItemResource:
type: object
properties:
Description:
type: string
AbbreviatedDescription:
type: string
Guid:
format: uuid
type: string
example: 00000000-0000-0000-0000-000000000000
ApiSubscriberResource:
type: object
properties:
Name:
type: string
CompanyOutlets:
type: array
items:
$ref: '#/definitions/ApiSubscriberCompanyOutletResource'
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