package
0.22.0
Repository: https://github.com/epfl-si/go-toolbox.git
Documentation: pkg.go.dev

# Packages

No description provided by the author

# Functions

CallApi calls the API with the specified HTTP verb, URL, payload, user ID, and password.
GetAccred: get a accred Parameters: - accredId string: the <sciper>:<unitid> of the accred Return type(s): - *api.Accred: the accred - int: response http status code - error: any error encountered.
GetAccreds retrieves accreditations for the given persons and unit IDs.
GetAccredsFromUrl: retrieves accreditations from the given URL Parameter(s): - url string: the URL to retrieve accreditations from Return type(s): - []*api.Accred: slice of accreditations - int64: count - int: response http status code - error: any error encountered.
GetAuthorizations: retrieves authorizations based on provided parameters Parameters: - persIds string: the person IDs (scipers separated by a comma) - resIds string: the resource IDs (resource IDs separated by a comma) - authType string: the authorization type (right, role, property, status) - authIds string: the authorization IDs (authorization IDs or names separated by a comma) Return type(s): - []*api.Authorization: slice of authorizations - int64: count - int: response http status code - error: any error encountered.
GetAuthorizationsFromUrl: retrieves authorizations from the given URL Parameter(s): - url string - the URL to fetch authorizations from Return type(s): - []*api.Authorization: slice of authorizations - int64: count - int: HTTP status code - error: any error encountered.
GetBuilding: retrieves a building by its ID or name Parameters: - id string: the ID or name of the building to retrieve Return type(s): - *api.Building: the building - int: response http status code - error: any error encountered.
GetGroup: retrieves a group by its ID or name Parameters: - groupId string: the ID or name of the group to retrieve Return type(s): - *api.Group: the group - int: response http status code - error: any error encountered.
GetGroupAdmins: retrieves admins of a group by its ID or name Parameters: - groupId string: the ID or name of the group to retrieve Return type(s): - []*api.Member: group's admins - int: response http status code - error: any error encountered.
GetGroupMembers: retrieves members of a group by its ID or name Parameters: - groupId string: the ID or name of the group to retrieve Return type(s): - MembersResponse: group's members - int: response http status code - error: any error encountered.
GetGroupPersons: retrieves persons in a group by its ID or name Parameters: groupId string - the ID or name of the group to retrieve.
GetGroups: retrieves groups Parameters: - name string: name of a group - owner string: sciper of the owner of a group - admin string: sciper of the admin of a group - member string: ID of a member of a group Return type(s): - []*api.Group: groups - int64: count - int: response http status code - error: any error encountered.
No description provided by the author
GetList: retrieves a list by its ID or name Parameters: - listId string: the ID or name of the list to retrieve.
GetListMembers: get members of a list Parameters: - id string: list ID Return type(s): - []*api.Person: the members of the list - int: response http status code - error: any error encountered.
GetLists: search lists Parameters: - query string: search query - unitid string: unit ID of the lists - type string: type of lists (personnel, batiment, roles, droits, classes, etc.) - subtype string: subtype of lists (assistants, enseignants, etc.) Return type(s): - []*api.List: the matching lists - int64: count - int: response http status code - error: any error encountered.
GetMemberships: retrieve all memberships Return type(s): - MembershipsResponse: memberships - int: response http status code - error: any error encountered.
GetPerson: retrieves a person by their ID Parameters: - persId string: the ID or name of the list to retrieve.
GetPersons retrieves persons.
GetPosition: retrieves a position Parameters: - id int: ID of the position Return type(s): - *api.Position: accred position - int: response http status code - error: any error encountered.
GetPositions: retrieves positions Parameters: - search string: string to search for - restricted bool: only show restricted positions - unitId string: only show available positions for this unit Return type(s): - []*api.Position: accred positions - int64: count - int: response http status code - error: any error encountered.
GetProperties: retrieves properties Parameters: - search string: string to search for Return type(s): - []*api.Property: accred properties - int64: count - int: response http status code - error: any error encountered.
GetProperty: retrieves a property Parameters: - idOrName string: ID or name of the property Return type(s): - *api.Property: accred property - int: response http status code - error: any error encountered.
GetRight: retrieves a right Parameters: - idOrName string: ID or name of the right Return type(s): - *api.Right: accred right - int: response http status code - error: any error encountered.
GetRights: retrieves rights Parameters: - search string: string to search for Return type(s): - []*api.Right: accred rights - int64: count - int: response http status code - error: any error encountered.
GetRole: retrieves a role Parameters: - idOrName string: ID or name of the role Return type(s): - *api.Role: accred role - int: response http status code - error: any error encountered.
GetRoles: retrieves roles Parameters: - search string: string to search for Return type(s): - []*api.Role: accred roles - int64: count - int: response http status code - error: any error encountered.
GetRoom: retrieves a building by its ID or name Parameters: - id string: the ID or name of the building to retrieve Return type(s): - *api.Room: the building - int: response http status code - error: any error encountered.
GetRooms: retrieves rooms Parameters: - query string: the query to search Return type(s): - []*api.Room: the matching rooms - int64: count - int: response http status code - error: any error encountered.
GetService: retrieves a service by its ID or name Parameters: - serviceId string: the ID or name of the service to retrieve Return type(s): - *api.Service: the service - int: response http status code - error: any error encountered.
GetServices: retrieves services by name, unitId, persid, network property Parameters: - name string: name of the service - unitIds string: ID of unit(s) of the service(s) to retrieve - persIds string: ID of person(s) managing the service(s) to retrieve - network string: whether network property is active or not ("0" or "1") Return type(s): - []*api.Service: slice of services - int64: count - int: response http status code - error: any error encountered.
GetSite: retrieves a building by its ID or name Parameters: - id string: the ID or name of the site to retrieve Return type(s): - *api.Site: the site - int: response http status code - error: any error encountered.
GetStatus: retrieves a status Parameters: - idOrName string: ID or name of the status Return type(s): - *api.Status: accred status - int: response http status code - error: any error encountered.
GetStatuses: retrieves statuses Parameters: - search string: string to search for Return type(s): - []*api.Status: accred statuses - int64: count - int: response http status code - error: any error encountered.
GetUnit: retrieves a unit by its ID or name Parameters: - unitId string: the ID or name of the unit to retrieve Return type(s): - *api.Unit: the unit - int: response http status code - error: any error encountered.
GetUnits: retrieves units Parameters: - query string: the query to search Return type(s): - []*api.Unit: the matching units - int64: count - int: response http status code - error: any error encountered.
GetUnitTypes: retrieves unit types Return type(s): - []*api.UnitType: the matching units - int: response http status code - error: any error encountered.
No description provided by the author
No description provided by the author

# Structs

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author