Service Definition

Authentication:

OAuth 2.0

Authorization:

Read access

Online documentation with swagger:

Testplattform   url: 

Prodplattform  url:

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.

Service Address:

GetAddressByID

Function: Return address find by customerId

URL: /v1/Address/{id}

URL parameter id = Costomerid

Response structure:

{
  "id": 0,
  "lastname": "string",
  "firstname": "string",
  "emails": [
    "string"
  ],
  "company": "string",
  "function": "string",
  "addressType": "string",
  "street": "string",
  "city": "string",
  "zip": "string",
  "country": "string",
  "lastUpdate": "2024-11-20T07:53:44.228Z",
  "adressZusatz": "string",
  "kundeSeit": "2024-11-20T07:53:44.228Z",
  "sprachId": 0,
  "nrUndName": "string",
  "ganzeAdresse": "string"
}

Affected  DB-Entitties: tbl_Customers, tbl_EMail   

• Relation 1...0 or n
• email ==> List of Mailaddress with tbl.Customers.Id   (list<string>()) fieldname = From
• "{description}" <mailaddress>  f.e.  "Janick Kübler - Busmiete.ch" <j.kuebler@busmiete.ch>

GetAddressByCompanyName (or more)

Function: All addresses find by company name or in combination with other attributes

URL: /v1/Address/ByCompany?companyName={}&street=e{}&zip={}

Url parameter

• company = company name
• optional street
• optional zip

Response structure same as for GetAddressByID

Service Order:

DB-Entity: tbl_PickUps, tbl_Auftragsposten (not sure ?)

url:  ..\

Function: 

All customer information from the mandate.

PK:  ID (Customer) int

The rest of the information can be seen in the Swagger UI

Der Mandant: Busmietech_GmbH ist fix verdrahtet

Zur Bestimmung des Custmers kann über ID oder Firmanamen + Strasse  + PLZ  Ort genutzt werden.