Optionaloptions: GetQualificationOptionsOptionaloptions: GetAnimalsOptionsOptionaloptions: GetQualificationOptionsOptionaloptions: GetIncidentOptionsOptionaloptions: GetMemberOptionsOptionaloptions: GetMemberAwardsOptionsOptionaloptions: GetMemberGroupsOptionsOptionaloptions: GetQualificationOptionsOptionaloptions: GetMembersOptionsThe point of view from where the request takes place
+Either a team, organisation or admin's id
+The point of view from where the request takes place
+Either a team, organisation or admin's id
+The numeric identifier for a resource
+The point of view from where the request takes place
+Either a team, organisation or admin's id
+Optionaloptions: {Optionalactivity_id?: number | number[]One or more activity resource identifiers
+Optionalactivity_resource_type?: stringOne or more attendance statuses
+Optionaldeleted?: booleanReturn only attendances from deleted activities
+Optionalends_after?: stringReturn only resources ending after this datetime
+Optionalends_before?: stringReturn only resources ending before this datetime
+Optionalid?: number | number[]A list of ids
+Optionalmember_id?: number | number[]One or more member resource identifiers
+Optionalorder?: "asc" | "desc"Default: "asc"
+Optionalpage?: numberPage number
+Optionalrole_id?: number | number[]One or more role resource identifiers
+Optionalsize?: numberItems per page
+Optionalsort?: "createdAt" | "id" | "updatedAt"Default: "id"
+Optionalstarts_after?: stringReturn only resources starting after this datetime
+Optionalstarts_before?: stringReturn only resources starting before this datetime
+Optionalstatus?: stringOne or more attendance statuses
+The point of view from where the request takes place
+Either a team, organisation or admin's id
+An animal id
+The point of view from where the request takes place
+Either a team, organisation or admin's id
+Optionaloptions: {Optionalhandler_member_id?: number | number[]The member id or ids of the animal's handler(s)
+Optionalid?: number | number[]A list of ids
+Optionalorder?: "asc" | "desc"Default: "asc"
+Optionalpage?: numberPage number
+Optionalsize?: numberItems per page
+Optionalsort?: "createdAt" | "id" | "updatedAt"Default: "id"
+Optionalstatus?: "NON_OPERATIONAL" | "OPERATIONAL"The status of the animal
+Optionalteam_id?: numberThe numeric identifier for a resource
+The point of view from where the request takes place
+Either a team, organisation or admin's id
+A group identifier
+The point of view from where the request takes place
+Either a team, organisation or admin's id
+Optionaloptions: {Optionalgroup_id?: number | number[]One or more group identifiers
+Optionalid?: number | number[]A list of ids
+Optionalmember_id?: number | number[]One or more member identifiers
+Optionalorder?: "asc" | "desc"Default: "asc"
+Optionalpage?: numberPage number
+Optionalsize?: numberItems per page
+Optionalsort?: "createdAt" | "id" | "updatedAt"Default: "id"
+Optionalteam_id?: number | number[]One or more team identifiers
+The point of view from where the request takes place
+Either a team, organisation or admin's id
+Optionaloptions: {Optionalid?: numberA list of ids
+Optionalorder?: "asc" | "desc"Default: "asc"
+Optionalpage?: numberPage number
+Optionalsize?: numberItems per page
+Optionalsort?: "createdAt" | "id" | "updatedAt"Default: "id"
+Optionalteam_id?: number | number[]One or more team identifiers
+Optionaltitle?: stringA simple text search term, compared against the title
+The point of view from where the request takes place
+Either a team, organisation or admin's id
+An activity identifier
+The point of view from where the request takes place
+Either a team, organisation or admin's id
+Optionaloptions: {Optionalafter?: stringReturn only activities ending after this datetime
+Optionalbefore?: stringReturn only activities starting before this datetime
+Optionaldeleted?: booleanReturn only deleted activities
+Optionalends_before?: stringReturn only activities ending before this datetime
+Optionalid?: number | number[]A list of ids
+Optionalorder?: "asc" | "desc"Default: "asc"
+Optionalpage?: numberPage number
+Optionalpublished?: booleanReturn only published activities
+Optionalreference?: stringA simple text search term, compared against the reference and reference description
+Optionalsize?: numberItems per page
+Optionalsort?: "createdAt" | "id" | "updatedAt"Default: "id"
+Optionalstarts_after?: stringReturn only activities starting after this datetime
+Optionaltag_bundle_id?: numberReturn only activities with this tag bundle id
+Optionaltag_id?: numberReturn only activities with this tag id
+Optionalteam_id?: numberReturn only activities with this team id
+The point of view from where the request takes place
+Either a team, organisation or admin's id
+Member the resource belongs to. Either an id or "me"
+Optionaloptions: { includeDetails?: boolean }The point of view from where the request takes place
+Either a team, organisation or admin's id
+Optionaloptions: {Optionaldeleted?: booleanReturn only deleted members
+Optionalid?: number | number[]A list of ids
+Optionalid_tag?: stringRFID tag or barcode
+Optionalname?: stringThe member's name
+Optionalorder?: "asc" | "desc"Optionalpage?: numberPage number
+Optionalsize?: numberItems per page
+Optionalsort?: "createdAt" | "id" | "updatedAt"Optionalstatuses?: (null | number)[]One or more member statuses. Some statuses require extra permissions.
+Optionalteam_id?: numberThe numeric identifier for a resource
+The point of view from where the request takes place
+Either a team, organisation or admin's id
+An organisation's id
+The point of view from where the request takes place
+Either a team, organisation or admin's id
+The qualification's id
+Optionaloptions: { exclude_org_data?: boolean; exclude_teams_data?: boolean }Optionalexclude_org_data?: booleanTeam context: Exclude entities inherited from the team's org
+Optionalexclude_teams_data?: booleanOrganisation context: Exclude entities belonging to accessible teams
+The point of view from where the request takes place
+Either a team, organisation or admin's id
+Optionaloptions: {Optionalexclude_org_data?: booleanTeam context: Exclude entities inherited from the team's org
+Optionalexclude_teams_data?: booleanOrganisation context: Exclude entities belonging to accessible teams
+Optionalorder?: "asc" | "desc"Default: "asc"
+Optionalpage?: numberPage number
+Optionalsize?: numberItems per page
+Optionalsort?: "createdAt" | "id" | "updatedAt"Default: "id"
+Optionaltitle?: stringThe title of a resource
+The point of view from where the request takes place
+Either a team, organisation or admin's id
+The qualification's id
+Optionaloptions: { exclude_org_data?: boolean; exclude_teams_data?: boolean }Optionalexclude_org_data?: booleanTeam context: Exclude entities inherited from the team's org
+Optionalexclude_teams_data?: booleanOrganisation context: Exclude entities belonging to accessible teams
+The point of view from where the request takes place
+Either a team, organisation or admin's id
+Optionaloptions: {Optionalexclude_org_data?: booleanTeam context: Exclude entities inherited from the team's org
+Optionalexclude_teams_data?: booleanOrganisation context: Exclude entities belonging to accessible teams
+Optionalorder?: "asc" | "desc"Default: "asc"
+Optionalpage?: numberPage number
+Optionalsize?: numberItems per page
+Optionalsort?: "createdAt" | "id" | "updatedAt"Default: "id"
+Optionaltitle?: stringThe title of a resource
+The point of view from where the request takes place
+Either a team, organisation or admin's id
+Optionaloptions: {Optionalexclude_org_data?: booleanTeam context: Exclude entities inherited from the team's org
+Optionalexclude_teams_data?: booleanOrganisation context: Exclude entities belonging to accessible teams
+Optionalmember_id?: number | "me"Qualified member. Either an id or "me"
+Optionalorder?: "asc" | "desc"Default: "asc"
+Optionalpage?: numberPage number
+Optionalqualification_id?: numberThe qualification's id
+Optionalsize?: numberItems per page
+Optionalsort?: "createdAt" | "id" | "updatedAt"Default: "id"
+The point of view from where the request takes place
+Either a team, organisation or admin's id
+The qualification's id
+Optionaloptions: { exclude_org_data?: boolean; exclude_teams_data?: boolean }Optionalexclude_org_data?: booleanTeam context: Exclude entities inherited from the team's org
+Optionalexclude_teams_data?: booleanOrganisation context: Exclude entities belonging to accessible teams
+The point of view from where the request takes place
+Either a team, organisation or admin's id
+Optionaloptions: {Optionalexclude_org_data?: booleanTeam context: Exclude entities inherited from the team's org
+Optionalexclude_teams_data?: booleanOrganisation context: Exclude entities belonging to accessible teams
+Optionalorder?: "asc" | "desc"Default: "asc"
+Optionalpage?: numberPage number
+Optionalsize?: numberItems per page
+Optionalsort?: "createdAt" | "id" | "updatedAt"Default: "id"
+Optionaltitle?: stringThe title of a resource
+The point of view from where the request takes place
+Either a team, organisation or admin's id
+A role id
+The point of view from where the request takes place
+Either a team, organisation or admin's id
+A team's id
+Documentation is setup to be hosted on github pages, it is generated using typedoc.
+Typedoc documentation can be found here: https://typedoc.org/
+The files for the guides are located in the documentation folder, they are written in markdown
+To update the typedoc generated documentation for the module, run the following commands in the root of the repo:
+npm install # Install only needs to be run first time.
+npm run docs
+This library is not in NPM. As a result, you need to add it to your project and build it locally.
+To do so, you have three options:
+Regardless of which option you choose, the following steps all apply.
+Enter the lib directory for the library and run the following commands:
+npm install
+npm run build
+In your project directory, run the following:
+npm i /path/to/package/d4h-typescript/lib
+Using a relative path will also work without issue.
+Build simply builds the test project, while launch both builds and runs it. If you've made changes to lib, be sure to build there first.
Before launching, you should setup environment variables. sample.env shows you what variables are necessary. Copy the contents to a new file, .env, in the same folder and populate it appropriately.
To update typedoc docs after changes to code, run in the root of the repo:
+To update typedoc docs after changes to code, run in the root of the repo:
npm install
npm run docs
-