Skip to content

Add get_by_id to EdFiEndpoint #57

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ea-mtenhoor wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add get_by_id to EdFiEndpoint #57

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions edfi_api_client/edfi_endpoint.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,34 @@ def get(self, limit: Optional[int] = None, *, params: Optional[dict] = None, **k
return self.client.session.get_response(self.url, params=params, **kwargs).json()


def get_by_id(self, resource_id: str, *, params: Optional[dict] = None, **kwargs) -> dict:
"""
GET a single resource by id (Ed-Fi ``GET {collectionUrl}/{resource_id}``). The URL is built by joining ``resource_id`` to this
endpoint's collection URL (same path pattern as delete-by-id).

Query parameters are merged with those from endpoint construction the same
way as :meth:`get`; pagination parameters are usually irrelevant for a
single-resource GET.

:param resource_id: The resource ``id``: a GUID string without hyphens (32 hexadecimal characters), as returned by the Ed-Fi API.
:param params: Optional params overriding those set on the endpoint.
:return: A single resource as a dict (not a list).
:raises ValueError: If ``get_deletes`` or ``get_key_changes`` was set on this endpoint.
"""
if self.get_deletes or self.get_key_changes:
raise ValueError(
"get_by_id is not supported when get_deletes or get_key_changes is True."
)

url = util.url_join(self.url, resource_id)
logger.info(f"[Get by id {self.component}] Endpoint: {url}")

params = EdFiParams(params or self.params).copy()
logger.info(f"[Get by id {self.component}] Parameters: {params}")
Copy link
Copy Markdown
Collaborator

@jayckaiser jayckaiser Apr 29, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are there any params that are relevant to include when querying by ID directly? If not, I would want to omit these from being used to avoid the possibility of someone passing mutually-exclusive arguments and parameters (e.g., different IDs, etc.).


return self.client.session.get_response(url, params=params, **kwargs).json()
Copy link
Copy Markdown
Collaborator

@jayckaiser jayckaiser Apr 29, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To confirm, if the ID passed is undefined, will this return an empty dictionary?



def get_rows(self,
*,
params: Optional[dict] = None, # Optional alternative params
Expand Down Expand Up @@ -478,6 +506,11 @@ def url(self) -> str:
else:
raise ValueError("`filter_type` and `filter_id` must both be specified if a filter is being applied!")

def get_by_id(self, resource_id: str, *, params: Optional[dict] = None, **kwargs) -> dict:
raise NotImplementedError(
"get_by_id is not supported for composite endpoints; composites use collection URLs, not GET {resource}/{id}."
)

def get_total_count(self, *args, **kwargs):
"""
Ed-Fi 3 resources/descriptors can be fed an optional 'totalCount' parameter in GETs.
Expand Down