v1

Documentation

Index

• Constants
• type ChangePushTokenRequest
• type DeviceExposureKey
• type DownloadMetricsRequest
• type DownloadMetricsResponse
• type GetCovidDataRequest
• type GetCovidDataResponse
• type IsEhridActiveRequest
• type IsEhridActiveResponse
• type PublishKeysRequestDevice
• type PublishKeysRequestServer
• type PublishKeysResponseDevice
• type PublishKeysResponseServer
• type RegisterEhridRequest
• type RegisterEhridResponse
• type RegisterNotificationRequest
• type ReportType

Constants

const (
	Unknown                    = "Unknown"
	ConfirmedTest              = "ConfirmedTest"
	ConfirmedClinicalDiagnosis = "ConfirmedClinicalDiagnosis"
	SelfReport                 = "SelfReport"
	Recursive                  = "Recursive"
	Revoked                    = "Revoked"
)

Possible values of ReportType.

Types

type ChangePushTokenRequest

type ChangePushTokenRequest struct {
	IDToken               string `json:"idToken" validate:"required"`
	PushRegistrationToken string `json:"pushRegistrationToken" validate:"required"`
}

ChangePushTokenRequest Request for ChangePushToken function

type DeviceExposureKey

type DeviceExposureKey keyserverapi.ExposureKey

DeviceExposureKey is the 16 byte key, the start time of the key and the duration of the key. A duration of 0 means 24 hours.

type DownloadMetricsRequest

type DownloadMetricsRequest struct {
	Date string `json:"date"`
}

DownloadMetricsRequest Request for DownloadMetrics function

type DownloadMetricsResponse

type DownloadMetricsResponse = structs.MetricsData

DownloadMetricsResponse Response for DownloadMetrics function

type GetCovidDataRequest

type GetCovidDataRequest struct {
	IDToken string `json:"idToken" validate:"required"`
	Date    string `json:"date"`
}

GetCovidDataRequest Request for GetCovidData function

type GetCovidDataResponse

type GetCovidDataResponse struct {
	Date                       string `json:"date"`
	ActiveCasesTotal           int    `json:"activeCasesTotal"  validate:"required"`
	CuredTotal                 int    `json:"curedTotal"  validate:"required"`
	DeceasedTotal              int    `json:"deceasedTotal"  validate:"required"`
	CurrentlyHospitalizedTotal int    `json:"currentlyHospitalizedTotal"  validate:"required"`
	TestsTotal                 int    `json:"testsTotal"  validate:"required"`
	TestsIncrease              int    `json:"testsIncrease"  validate:"required"`
	TestsIncreaseDate          string `json:"testsIncreaseDate" validate:"required"`
	ConfirmedCasesTotal        int    `json:"confirmedCasesTotal"  validate:"required"`
	ConfirmedCasesIncrease     int    `json:"confirmedCasesIncrease"  validate:"required"`
	ConfirmedCasesIncreaseDate string `json:"confirmedCasesIncreaseDate" validate:"required"`
	AntigenTestsTotal          int    `json:"antigenTestsTotal" validate:"required"`
	AntigenTestsIncrease       int    `json:"antigenTestsIncrease"  validate:"required"`
	AntigenTestsIncreaseDate   string `json:"antigenTestsIncreaseDate" validate:"required"`
	PCRTestsTotal              int    `json:"pcrTestsTotal"  validate:"required"`
	PCRTestsIncrease           int    `json:"pcrTestsIncrease"  validate:"required"`
	PCRTestsIncreaseDate       string `json:"pcrTestsIncreaseDate" validate:"required"`
}

GetCovidDataResponse Response for GetCovidData function

type IsEhridActiveRequest

type IsEhridActiveRequest struct {
	IDToken string `json:"idToken" validate:"required"`
}

IsEhridActiveRequest Request for IsEhridActive function

type IsEhridActiveResponse

type IsEhridActiveResponse struct {
	Active bool `json:"active"`
}

IsEhridActiveResponse Response for IsEhridActive function

type PublishKeysRequestDevice

type PublishKeysRequestDevice struct {
	keyserverapi.Publish // embedded struct

	VisitedCountries    []string   `json:"visitedCountries"`
	ReportType          ReportType `json:"reportType"`
	ConsentToFederation bool       `json:"consentToFederation"`
}

PublishKeysRequestDevice represents the body of the PublishInfectedIds API call. It's received from device.

VisitedCountries: list (possibly empty) where the device has travelled to.

ReportType: type of report - is it self-report, confirmed diagnose, ...?

ConsentToFederation: whether user of the device has allowed to share his keys to other countries.

type PublishKeysRequestServer

type PublishKeysRequestServer keyserverapi.Publish

PublishKeysRequestServer represents the body of the PublishInfectedIds API call. It's sent to the key server.

type PublishKeysResponseDevice

type PublishKeysResponseDevice keyserverapi.PublishResponse

PublishKeysResponseDevice is sent back to the client on a publish request.

type PublishKeysResponseServer

type PublishKeysResponseServer keyserverapi.PublishResponse

PublishKeysResponseServer is got back from the key server on a publish request.

type RegisterEhridRequest

type RegisterEhridRequest struct {
	Platform              string `json:"platform" validate:"required,oneof=android ios"`
	PlatformVersion       string `json:"platformVersion" validate:"required"`
	Manufacturer          string `json:"manufacturer"`
	Model                 string `json:"model"`
	Locale                string `json:"locale" validate:"required"`
	PushRegistrationToken string `json:"pushRegistrationToken"`
}

RegisterEhridRequest Request for RegisterEhrid function

type RegisterEhridResponse

type RegisterEhridResponse struct {
	CustomToken string `json:"customToken"`
}

RegisterEhridResponse Response for RegisterEhrid function

type RegisterNotificationRequest

type RegisterNotificationRequest struct {
	IDToken string `json:"idToken" validate:"required"`
}

RegisterNotificationRequest Request for RegisterNotification function

type ReportType

type ReportType string

ReportType means type of the keys report - is it self-report, confirmed diagnose, ...?