Create default channels for companies

Creates new default channels for one or more companies based on the provided configuration.
This operation may create multiple channels if the serialnumber has been used by many companies

Example request:

{
  "serialNumber": "00192881293123",
  "username": "admin",
  "password": "password123",
  "orderSeries": "7022",
  "printFormSeries": "1111"
}

Example response:

{
  "channels": [
    {
      "id": "ABC-c96444d7-fd41-47e7-92b4-706c1d7406a4",
      "companyId": "COMP001"
    },
    {
      "id": "DEF-d87555e8-ge52-58f8-a3c5-817d2e8517b5",
      "companyId": "COMP002"
    }
  ]
}

Request

Body Params application/json

serialNumber

string

required

The serial number of the device/system

>= 1 characters

Example:

SN123456789

appId

string | null

optional

Application ID for the SoftOne system

Default:

955

Example:

955

username

string

required

Username for SoftOne authentication

>= 1 characters

Example:

admin

password

string

required

Password for SoftOne authentication

>= 1 characters

Example:

password123

orderSeries

string

required

Order series identifier in SoftOne

>= 1 characters

Example:

7022

printFormSeries

string

required

Print form series identifier in SoftOne

>= 1 characters

Example:

1111

Example

{
    "serialNumber": "SN123456789",
    "appId": "955",
    "username": "admin",
    "password": "password123",
    "orderSeries": "7022",
    "printFormSeries": "1111"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢201Channels created successfully

application/json

Body

channels

array[object (DefaultChannel) {2}] | null

optional

string | null

optional

Id of the created channel

Example:

ABC-c96444d7-fd41-47e7-92b4-706c1d7406a4

companyId

string | null

optional

Id of the Company the channel was created for

Example

{
    "channels": [
        {
            "id": "ABC-c96444d7-fd41-47e7-92b4-706c1d7406a4",
            "companyId": "string"
        }
    ]
}

🟠400Invalid request parameters

🟠404Company or configuration not found

🔴500Internal server error