Class Manager
GET /v1/addresses/

Get addresses for entity

Query parameters

  • entityId string Required

    Entity id

Responses

  • 403 application/json

    Not authorized

    Hide response attributes Show response attributes object

    Error schema

    • statusCode number Required

      Status Code

    • messages array[string] Required

      List of error messages

    • exception object

      Exception
  • 404 application/json

    Not found

    Hide response attributes Show response attributes object

    Error schema

    • statusCode number Required

      Status Code

    • messages array[string] Required

      List of error messages

    • exception object

      Exception
  • 200 application/json

    successful operation

    Hide response attribute Show response attribute object
    • addresses array[object] Required

      List of addresses for specific entity

      Address schema

      Hide addresses attributes Show addresses attributes object
      • id string

        id

      • companyId string Required

        Company ID

      • entityId string Required

        Entity ID

      • address1 string | null Required

        Address 1

      • address2 string | null Required

        Address 2

      • town string | null Required

        Town

      • state string | null Required

        State

      • countryCode string | null Required

        Country Code

      • zip string | null Required

        Zip
GET /v1/addresses/ 
curl \
 --request GET 'https://localhost/v1/addresses/?entityId=stf_xxxxxxxx&entityId=fml_xxxxxxxx'
Response examples (403) 
{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}
Response examples (404) 
{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}
Response examples (200) 
{
  "addresses": [
    {
      "zip": "12345",
      "town": "Springfield",
      "state": "IL",
      "address1": "123 Main St",
      "address2": "Apt 123",
      "countryCode": "US"
    }
  ]
}