Service Definition

Authentication:

OAuth 2.0

Authorization:

Read access

Status Code:

200 OK: Successful GET request.
201 Created: Successful creation of a resource.
400 Bad Request: Invalid request (e.g., missing parameters).
401 Unauthorized: Missing or incorrect authentication.
404 Not Found: Resource not found.
500 Internal Server Error: General server error.

AddressService:

/v1/Address/{id}:

Description: Retrieves an address based on the provided customerId

API URL: /{version}/Address/{id}

id: Represents the customerId

Json response structure:

{
  "id": 0,
  "lastname": "string",
  "firstname": "string",
  "communications": [
    {
      "address": "string",
      "communicationMediumId": 0
    }
  ],
  "company": "string",
  "function": "string",
  "addressType": "string",
  "street": "string",
  "city": "string",
  "zip": "string",
  "country": "string",
  "lastUpdate": "2024-12-11T07:26:36.434Z",
  "adressZusatz": "string",
  "kundeSeit": "2024-12-11T07:26:36.434Z",
  "sprachId": 0,
  "nrUndName": "string",
  "ganzeAdresse": "string"
}

he attributes map to the following text fields (see screenshot):

a <= company

b <= street

c <= zip

d <= city

e <= firstname

f <= lastname

g/h <= list of communications

address <= like phone number or e-mail address
communicationMediumId <= type of communication medium e.g privat phone number or business e-mail address

i <= sprachId

/v1/Address/ByCompany:

Description: Retrieves all addresses matching a CompanyName or a combination of street and zip.

API URL: /{version}/Address/ByCompany´?companyName={companyName}&street={street}&zip={zip}

Required attribute:

companyName: The name of the company.

Optional attribute:

street: Street name
zip: ZIP code

Json response structure: (same as /v1/Address/{id}):

{
  "id": 0,
  "lastname": "string",
  "firstname": "string",
  "communications": [
    {
      "address": "string",
      "communicationMediumId": 0
    }
  ],
  "company": "string",
  "function": "string",
  "addressType": "string",
  "street": "string",
  "city": "string",
  "zip": "string",
  "country": "string",
  "lastUpdate": "2024-12-11T07:26:36.434Z",
  "adressZusatz": "string",
  "kundeSeit": "2024-12-11T07:26:36.434Z",
  "sprachId": 0,
  "nrUndName": "string",
  "ganzeAdresse": "string"
}