bcgov / bcgov/SIMS

API documentation for ATBC API and Code refactoring PD/PPD

Open
#1,625 1 comment 0 reactions 0 assignees View on GitHub
Question Task
Dominant language
TypeScript
Stars
29
Forks
15
PR merge metrics
No merged PRs in 30d

Description

@Jason Who should take this on- Is this you?

**Describe the task**
Currently, we are not aware of all the responses returned by the ATBC API while applying for PD status. It is required to understand the different responses and also the errors returned by ATBC.
Right now we receive the below object as a response but we do not have further information about the possible information and how to handle it. For instance, are there different types of codes that can indicate different errors?

![image.png](https://images.zenhubusercontent.com/5fcebe3c076e6aaed83693fb/a0955554-9546-4e1e-98c5-01a87b34a506)

**Questions**
- Get the information from ATBC about the possible return information from the request PD.

Contributor guide

No contributing guide indexed for this repository

Research direction

No source file, test, or entry point is identified. Start by reviewing the PD request and the ATBC API response information referenced in the issue, then clarify the PD/PPD refactoring scope; done means documenting the possible responses and errors and how they should be handled.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.