Mercedes.VehicleManagement.API

<back to all web services

HealthRequest

The following routes are available for this service:
GET/status
package dtos

import (
	"time"
)

type HealthStatus string

const (
	HealthStatusUnhealthy HealthStatus = "Unhealthy"
	HealthStatusDegraded               = "Degraded"
	HealthStatusHealthy                = "Healthy"
)

type HealthCheckReportEntry struct {
	Key         *string       `json:"key,omitempty"`
	Description *string       `json:"description,omitempty"`
	Duration    time.Duration `json:"duration,omitempty"`
	Status      HealthStatus  `json:"status,omitempty"`
	Error       *string       `json:"error,omitempty"`
}

type HealthCheckReport struct {
	Status    HealthStatus             `json:"status,omitempty"`
	Duration  time.Duration            `json:"duration,omitempty"`
	Version   string                   `json:"version"`
	BuildDate *string                  `json:"buildDate,omitempty"`
	Entries   []HealthCheckReportEntry `json:"entries,omitempty"`
}

type HealthResponse struct {
	Result *HealthCheckReport `json:"result,omitempty"`
}

type HealthRequest struct {
}

Go HealthRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /status HTTP/1.1 
Host: uat-api-vehicle-mgt-mb-dhc.rapp-customers.co.uk 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"result":{"status":"Unhealthy","duration":"PT0S","version":"String","buildDate":"String"}}