Endpoint map¶
This page traces every remote member of IAgencyClient to the SAIF.Agency.Api endpoint it calls. It is the page a reader uses to answer "which endpoint does this call hit, and where is that endpoint documented".
| Field | Value |
|---|---|
| Wrapped API | SAIF.Agency.Api |
| Origin | Documented by this run |
| Base URL | <baseUrl> — constructor argument, from the AgencyApi.BaseUrl app setting |
| Version prefix | v1/ |
| Remote members mapped | 4 of 4 public members |
Method to endpoint map¶
| Client member | Verb | Relative URL | Endpoint | Request DTO | Response DTO | Reference |
|---|---|---|---|---|---|---|
GetAgency |
GET | agencies/{agencyNumber} |
GET /v1/agencies/{agencyNumber} |
— | Agency |
Details |
SearchAgencies |
GET | agencies?producerCode={producerCode}&activeOnly={activeOnly} |
GET /v1/agencies |
— | AgencySummary |
Details |
GetAgentsForAgency |
GET | agencies/{agencyNumber}/agents |
GET /v1/agencies/{agencyNumber}/agents |
— | Agent |
Details |
UpdateAgencyContact |
PUT | agencies/{agencyNumber}/contact |
PUT /v1/agencies/{agencyNumber}/contact |
AgencyContactUpdate |
AgencyContact |
Details |
All four routes are served by AgenciesController, so every row resolves to the
same endpoint page. The API's other two controllers are not wrapped: this client
issues no request to the v1/agents routes on AgentsController or the
v1/appointments routes on AppointmentsController. A consumer that needs
appointment history calls the API directly.
Note that GetAgentsForAgency reaches agent data through the agencies
sub-resource, not through AgentsController. The distinction matters when
tracing a production incident from an IIS log back to a client member.
Coverage¶
| Check | Result |
|---|---|
Public members in IAgencyClient |
4 |
| Rows in the endpoint map | 4 |
| Rows in unmapped members | 0 |
| Every mapped row resolves or is †-marked | Yes |
Related documentation¶
- Client index
- Overview
- Architecture
- Package
- Client reference
- Consumption
- Contracts
- Dependencies
- Business rules
- Tech debt
Sources¶
src/SAIF.Agency.Api.Client/IAgencyClient.cssrc/SAIF.Agency.Api.Client/AgencyClient.cssrc/SAIF.Agency.Api/Controllers/AgenciesController.cssrc/SAIF.Agency.Api/App_Start/WebApiConfig.cs