Get Offices

GET /v1/offices

Responses

200 application/json

Request succeeded.
Hide response attributes Show response attributes object
- id string(uuid)
  
  The unique id.
- createdTimestamp string(date-time) | null
  
  The date and time of creation in UTC time.
- modifiedTimestamp string(date-time) | null
  
  The date and time last modification in UTC time.
- name string Required
  
  The name.
- shortName string | null
  
  The short name.
- inactiveDate string(date) | null
  
  The date the office went inactive.
- addressCity string | null
  
  The city.
- addressProvinceCode string | null
  
  The two character state or province code.
- addressPostalCode string | null
  
  The postal code. This will be unformatted.
- code string Required
  
  The code for the office.
- startDate string(date) | null
  
  The date the office opened.
400 application/json

Invalid request. See response body for details.
Hide response attributes Show response attributes object
- id string
  
  The unique identifier for the error.
- code integer(int32)
  
  A code used to help identify the type of error. This is typically set to the same value as the http status code.
- message string
  
  A summary or short message describing the error.
- details array[string] | null
  
  A list of more detailed errors messages.
401 application/json

Unauthorized. See response body for details.
Hide response attributes Show response attributes object
- id string
  
  The unique identifier for the error.
- code integer(int32)
  
  A code used to help identify the type of error. This is typically set to the same value as the http status code.
- message string
  
  A summary or short message describing the error.
- details array[string] | null
  
  A list of more detailed errors messages.
403 application/json

Permission denied. See response body for details.
Hide response attributes Show response attributes object
- id string
  
  The unique identifier for the error.
- code integer(int32)
  
  A code used to help identify the type of error. This is typically set to the same value as the http status code.
- message string
  
  A summary or short message describing the error.
- details array[string] | null
  
  A list of more detailed errors messages.

GET /v1/offices

curl \
 --request GET 'https://api.lwolf.com/backoffice/v1/offices'

Response examples (200)

[
  {
    "id": "string",
    "code": "string",
    "name": "string",
    "shortName": "string",
    "startDate": "string",
    "addressCity": "string",
    "inactiveDate": "string",
    "createdTimestamp": "string",
    "addressPostalCode": "string",
    "modifiedTimestamp": "string",
    "addressProvinceCode": "string"
  }
]

Response examples (400)

{
  "id": "string",
  "code": 0,
  "details": [
    "string"
  ],
  "message": "string"
}

Response examples (401)

{
  "id": "string",
  "code": 0,
  "details": [
    "string"
  ],
  "message": "string"
}

Response examples (403)

{
  "id": "string",
  "code": 0,
  "details": [
    "string"
  ],
  "message": "string"
}