Create a new calling station

POST 
/calling-stations

The Create Calling Station request allows you to create a new calling station in ANSCER FMS.

Request

application/json

Body

required

name stringrequired
username stringrequired
password stringrequired
locations string[]required
storeId uuidrequired

Responses

201

Calling Station created

application/json

Schema

Schema

_id uuid
name string

Possible values: >= 3 characters and <= 50 characters

username string

Possible values: >= 5 characters and <= 50 characters

locations string[]
approvalRequired boolean
sku string[]
load object
alias object
property name* string
stationType string

Possible values: [web, physical]

requestType string

Possible values: [pickup, dropoff, empty]

storeId uuid
createdAt date-time
updatedAt date-time

Example (from schema)

{
  "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "username": "string",
  "locations": [
    "string"
  ],
  "approvalRequired": true,
  "sku": [
    "string"
  ],
  "load": {},
  "alias": {},
  "stationType": "web",
  "requestType": "pickup",
  "storeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2025-06-05T13:40:40.520Z",
  "updatedAt": "2025-06-05T13:40:40.520Z"
}

400

Bad Request due to validation errors in the request body

application/json

Schema

Schema

any

Example (from schema)

{
  "message": "Validation failed.",
  "errors": [
    {
      "field": "username",
      "message": "Username is required."
    },
    {
      "field": "password",
      "message": "Password must be 6 characters or longer."
    },
    {
      "field": "name",
      "message": "name is required"
    },
    {
      "field": "locations",
      "message": "Locations can not be empty"
    },
    {
      "field": "storeId",
      "message": "Invalid ObjectId"
    }
  ]
}

Example

{
  "message": "Validation failed.",
  "errors": [
    {
      "field": "username",
      "message": "Username is required."
    },
    {
      "field": "password",
      "message": "Password must be 6 characters or longer."
    },
    {
      "field": "name",
      "message": "name is required"
    },
    {
      "field": "locations",
      "message": "Locations can not be empty"
    },
    {
      "field": "storeId",
      "message": "Invalid ObjectId"
    }
  ]
}

401

Unauthorized.

application/json

Schema

Schema

any

Example (from schema)

{
  "message": "Authentication token not provided."
}

Example

{
  "message": "Authentication token not provided."
}

403

Forbidden.

application/json

Schema

Schema

any

Example (from schema)

{
  "message": "Access to this resource is forbidden."
}

Example

{
  "message": "Access to this resource is forbidden."
}

409

A calling station with the given username already exists.

application/json

Schema

Schema

any

Example (from schema)

{
  "message": "A calling station with the given username already exists."
}

Example

{
  "message": "A calling station with the given username already exists."
}

500

Internal Server Error

application/json

Schema

Schema

any

Example (from schema)

{
  "message": "Internal Server Error. Please try again later."
}

Example

{
  "message": "Internal Server Error. Please try again later."
}

Loading...