Documentation
¶
Index ¶
- Constants
- type DivisionStatus
- type DivisionsGetParams
- type DivisionsGetResponse
- type DivisionsUser
- type Gender
- type MeGetParams
- type MeGetResponse
- type MeUser
- type Service
- func (s *Service) DivisionsGet(requestParams *DivisionsGetParams, ctx context.Context) (*DivisionsGetResponse, error)
- func (s *Service) MeGet(requestParams *MeGetParams, ctx context.Context) (*MeGetResponse, error)
- func (s *Service) NewDivisionsGetParams() *DivisionsGetParams
- func (s *Service) NewDivisionsGetResponse() *DivisionsGetResponse
- func (s *Service) NewMeGetParams() *MeGetParams
- func (s *Service) NewMeGetResponse() *MeGetResponse
Constants ¶
View Source
const (
DivisionsEndpoint = "/v1/{division}/system/Divisions"
)
View Source
const (
MeEndpoint = "/v1/current/Me"
)
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type DivisionStatus ¶
type DivisionStatus int32
0 for Inactive, 1 for Active and 2 for Archived Divisions
type DivisionsGetParams ¶
type DivisionsGetParams struct {
// @TODO: check if this an OData struct or something
Select string `schema:"$select,omitempty"`
Filter string `schema:"$filter,omitempty"`
}
func (*DivisionsGetParams) FromQueryParams ¶
func (p *DivisionsGetParams) FromQueryParams(queryParams url.Values) error
type DivisionsGetResponse ¶
type DivisionsGetResponse []DivisionsUser
type DivisionsUser ¶
type DivisionsUser struct {
MetaData edm.MetaData `json:"__metadata"`
Code edm.Int32 `json:"Code"`
AddressLine1 edm.String `json:"AddressLine1"`
AddressLine2 edm.String `json:"AddressLine2"`
AddressLine3 edm.String `json:"AddressLine3"`
ChamberOfCommerceNumber edm.String `json:"ChamberOfCommerceNumber"`
City edm.String `json:"City"`
Country edm.String `json:"Country"`
Created edm.DateTime `json:"Created"`
Currency edm.String `json:"Currency"`
Current edm.Boolean `json:"Current"`
Customer edm.GUID `json:"Customer"`
CustomerCode edm.String `json:"CustomerCode"`
CustomerName edm.String `json:"CustomerName"`
Description edm.String `json:"Description"`
Email edm.String `json:"Email"`
Hid edm.Int64 `json:"Hid,string"`
IsMainDivision edm.Boolean `json:"IsMainDivision"`
Modified edm.DateTime `json:"Modified"`
Phone edm.String `json:"Phone"`
Postcode edm.String `json:"Postcode"`
State edm.String `json:"State"`
Status DivisionStatus `json:"Status"`
}
type MeGetParams ¶
type MeGetParams struct {
// @TODO: check if this an OData struct or something
Select string `schema:"$select"`
Filter string `schema:"$filter"`
}
func (*MeGetParams) FromQueryParams ¶
func (p *MeGetParams) FromQueryParams(queryParams url.Values) error
type MeGetResponse ¶
type MeGetResponse struct {
Results []MeUser `json:"results"`
}
type MeUser ¶
type MeUser struct {
MetaData edm.MetaData `json:"__metadata"`
UserID edm.GUID `json:"UserID"`
CurrentDivision edm.Int32 `json:"CurrentDivision"`
DivisionCustomer edm.GUID `json:"DivisionCustomer"`
DivisionCustomerCode edm.String `json:"DivisionCustomerCode"`
Email edm.String `json:"Email"`
EmployeeID edm.GUID `json:"EmployeeID"`
FirstName edm.String `json:"FirstName"`
FullName edm.String `json:"FullName"`
Gender Gender `json:"Gender"`
Initials edm.String `json:"Initials"`
Language edm.String `json:"Language"`
LanguageCode edm.String `json:"LanguageCode"`
LastName edm.String `json:"LastName"`
Legislation edm.Int64 `json:"Legislation,string"`
MiddleName edm.String `json:"MiddleName"`
Mobile edm.String `json:"Mobile"`
Nationality edm.String `json:"Nationality"`
Phone edm.String `json:"Phone"`
PhoneExtension edm.String `json:"PhoneExtension"`
PictureURL utils.URL `json:"PictureUrl"`
ServerTime edm.String `json:"ServerTime"`
ServerUtcOffset edm.Double `json:"ServerUtcOffset"`
ThumbnailPicture edm.Binary `json:"ThumbnailPicture"`
ThumbnailPictureFormat edm.String `json:"ThumbnailPictureFormat"`
Title edm.String `json:"Title"`
UserName edm.String `json:"UserName"`
}
type Service ¶
type Service struct {
// contains filtered or unexported fields
}
func NewService ¶
func (*Service) DivisionsGet ¶
func (s *Service) DivisionsGet(requestParams *DivisionsGetParams, ctx context.Context) (*DivisionsGetResponse, error)
func (*Service) MeGet ¶
func (s *Service) MeGet(requestParams *MeGetParams, ctx context.Context) (*MeGetResponse, error)
func (*Service) NewDivisionsGetParams ¶
func (s *Service) NewDivisionsGetParams() *DivisionsGetParams
func (*Service) NewDivisionsGetResponse ¶
func (s *Service) NewDivisionsGetResponse() *DivisionsGetResponse
func (*Service) NewMeGetParams ¶
func (s *Service) NewMeGetParams() *MeGetParams
func (*Service) NewMeGetResponse ¶
func (s *Service) NewMeGetResponse() *MeGetResponse
Click to show internal directories.
Click to hide internal directories.