Authenticate Calling Station

POST 
/calling-stations/auth

The Authenticate Calling Station request allows calling stations to authenticate themselves with ANSCER FMS by providing their username and password.

Request

application/json

Body

required

username stringrequired

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

password stringrequired

Possible values: >= 6 characters and <= 16 characters

Responses

200

Calling Station authenticated

Response Headers

• x-auth-token string

  JWT token

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
token string

JWT token

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.737Z",
  "updatedAt": "2024-12-03T13:25:44.737Z",
  "token": "string"
}

400

Bad Request due to validation errors in the request body

application/json

Schema

Schema

any

Example (from schema)

{
  "message": "Validation failed.",
  "errors": [
    {
      "field": "email",
      "message": "Email must be a valid email address."
    },
    {
      "field": "password",
      "message": "Password must be 6 characters or longer."
    }
  ]
}

Example

{
  "message": "Validation failed.",
  "errors": [
    {
      "field": "email",
      "message": "Email must be a valid email address."
    },
    {
      "field": "password",
      "message": "Password must be 6 characters or longer."
    }
  ]
}

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

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