Update a calling station by ID

PUT 
/calling-stations/:id

The Update Calling Station request allows you to update information about a specific calling station in ANSCER FMS.

Request

Path Parameters

id stringrequired

The ID of the calling station to retrieve, update or delete

application/json

Body

required

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

Possible values: [web, physical]

requestType string

Possible values: [pickup, dropoff, empty]

Responses

200

Calling Station updated

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 string
alias object
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": "string",
  "alias": {},
  "stationType": "web",
  "requestType": "pickup",
  "storeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2024-12-03T13:25:44.763Z",
  "updatedAt": "2024-12-03T13:25:44.763Z"
}

400

Bad Request due to validation errors in the request body

application/json

Schema

Schema

any

Example (from schema)

{
  "message": "Validation failed.",
  "errors": [
    {
      "field": "name",
      "message": "Name is required."
    },
    {
      "field": "email",
      "message": "Email must be a valid email address."
    }
  ]
}

Example

{
  "message": "Validation failed.",
  "errors": [
    {
      "field": "name",
      "message": "Name is required."
    },
    {
      "field": "email",
      "message": "Email must be a valid email address."
    }
  ]
}

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."
}

404

Resource not found.

application/json

Schema

Schema

any

Example (from schema)

{
  "message": "Resource not found."
}

Example

{
  "message": "Resource not found."
}

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...