minedash

README

minedash-api

Mine Dash Library

Documentation

Index

• type DeletedEntityResponse
• type Entity
• type EntityAllResponse
• type MineDashServer
  • func NewMineDashServer(server, username, password string) *MineDashServer
  • func (mds *MineDashServer) DeleteEntity(sysid int) error
  • func (mds *MineDashServer) GetEntities() (*[]Entity, error)
  • func (mds *MineDashServer) GetEntity(sysid int) (*Entity, error)
  • func (mds *MineDashServer) NewEntity(entity *Entity) (*Entity, error)
• type NewEntityRequest
• type Str
  • func (w Str) String() string
  • func (w *Str) UnmarshalJSON(data []byte) (err error)

Types

type DeletedEntityResponse

type DeletedEntityResponse struct {
	ErrorCode string `json:"errorCode"`
	ErrorDesc string `json:"errorDescription"`
}

type Entity

type Entity struct {
	CorpId      Str         `json:"corpId"`
	EntityLabel string      `json:"entityLabel"`
	EntityType  string      `json:"entityType"`
	ExternalId  string      `json:"externalId"`
	OnSite      bool        `json:"onSite"`
	SysId       json.Number `json:"sysId"`
}

type EntityAllResponse

type EntityAllResponse struct {
	Entities []Entity `json:"entity"`
}

type MineDashServer

type MineDashServer struct {
	// contains filtered or unexported fields
}

func NewMineDashServer

func NewMineDashServer(server, username, password string) *MineDashServer

func (*MineDashServer) DeleteEntity

func (mds *MineDashServer) DeleteEntity(sysid int) error

func (*MineDashServer) GetEntities

func (mds *MineDashServer) GetEntities() (*[]Entity, error)

func (*MineDashServer) GetEntity

func (mds *MineDashServer) GetEntity(sysid int) (*Entity, error)

func (*MineDashServer) NewEntity

func (mds *MineDashServer) NewEntity(entity *Entity) (*Entity, error)

type NewEntityRequest

type NewEntityRequest struct {
	EntityType      string `json:"entityType"`
	CorpId          Str    `json:"corpId"`
	ExternalId      string `json:"externalId"`
	FirstName       string `json:"firstName"`
	LastName        string `json:"lastName"`
	AlternativeName string `json:"alternativeName"`
	JobTitle        string `json:"jobTitle"`
	PersonalPhone   string `json:"personalPhone"`
	OfficePhone     string `json:"officePhone"`
}

type Str

type Str string

func (Str) String

func (w Str) String() string

func (*Str) UnmarshalJSON

func (w *Str) UnmarshalJSON(data []byte) (err error)