A user can query the Historic JOA API endpoint #5

Activity

1. paddy74

   added

   enhancementNew feature or requestNew feature or request

   on Sep 11, 2025
2. paddy74 commented on Sep 11, 2025

   

   paddy74

   on Sep 11, 2025

   OwnerAuthor

   More actions

   Here is an initial generated solution for usajobsapi/endpoints/historicjoa.py

   class HistoricJoaEndpoint(BaseModel):
       """Historic JOAs endpoint (no auth; uses continuation tokens)."""
       method: str = "GET"
       path: str = "/api/historicjoa"  # per docs. :contentReference[oaicite:2]{index=2}
   
       class Params(BaseModel):
           model_config = ConfigDict(frozen=True, extra="forbid", populate_by_name=True)
   
           # Per docs, all are optional filters:
           hiring_agency_codes: Optional[str] = Field(None, serialization_alias="HiringAgencyCodes")
           hiring_department_codes: Optional[str] = Field(None, serialization_alias="HiringDepartmentCodes")
           position_series: Optional[str] = Field(None, serialization_alias="PositionSeries")
           announcement_numbers: Optional[str] = Field(None, serialization_alias="AnnouncementNumbers")
           usajobs_control_numbers: Optional[str] = Field(None, serialization_alias="USAJOBSControlNumbers")
           start_position_open_date: Optional[str] = Field(None, serialization_alias="StartPositionOpenDate")  # YYYY-MM-DD
           end_position_open_date: Optional[str] = Field(None, serialization_alias="EndPositionOpenDate")
           start_position_close_date: Optional[str] = Field(None, serialization_alias="StartPositionCloseDate")
           end_position_close_date: Optional[str] = Field(None, serialization_alias="EndPositionCloseDate")
           continuation_token: Optional[str] = Field(None, serialization_alias="continuationtoken")
   
           def to_params(self) -> Dict[str, str]:
               return _dump_by_alias(self)
   
       class Item(BaseModel):
           usajobs_control_number: int = Field(alias="usajobsControlNumber")
           position_title: Optional[str] = Field(default=None, alias="positionTitle")
           hiring_agency_code: Optional[str] = Field(default=None, alias="hiringAgencyCode")
           hiring_department_code: Optional[str] = Field(default=None, alias="hiringDepartmentCode")
           position_open_date: Optional[str] = Field(default=None, alias="positionOpenDate")
           position_close_date: Optional[str] = Field(default=None, alias="positionCloseDate")
           minimum_salary: Optional[float] = Field(default=None, alias="minimumSalary")
           maximum_salary: Optional[float] = Field(default=None, alias="maximumSalary")
   
       class PagingMeta(BaseModel):
           total_count: Optional[int] = Field(default=None, alias="totalCount")
           page_size: Optional[int] = Field(default=None, alias="pageSize")
           continuation_token: Optional[str] = Field(default=None, alias="continuationToken")
   
       class Paging(BaseModel):
           metadata: HistoricJoaEndpoint.PagingMeta
           next: Optional[str] = None
   
       class Response(BaseModel):
           paging: Optional[HistoricJoaEndpoint.Paging] = None
           data: List[HistoricJoaEndpoint.Item] = Field(default_factory=list)
   
           def next_token(self) -> Optional[str]:
               return self.paging.metadata.continuation_token if self.paging and self.paging.metadata else None
3. paddy74

   self-assigned this

   on Sep 11, 2025
4. paddy74

   linked a pull request that will close this issuefeat(api): support the historic joa api endpoint #12on Sep 24, 2025
5. paddy74

   closed this as completedin #12on Sep 26, 2025