Funders File
AdministratorLookup
View SourceGetAdministrators
GetAdministrators - This returns a list of Healthcare Administrators
Request
POST /api/AdministratorLookup/GetAdministratorsParameters
| Name | In | Type | Default | Notes |
|---|---|---|---|---|
| *request | body |
|
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
OK |
|
| 404 | string | NotFound |
PlanLookup
View SourceGetPlans
GetPlans - Used to retrieve all the plans that are associated with a specific scheme
Request
POST /api/PlanLookup/GetPlansParameters
| Name | In | Type | Default | Notes |
|---|---|---|---|---|
| *request | body |
|
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
OK |
|
| 404 | string | NotFound |
SchemeLookup
View SourceGetSchemes
GetSchemes - Used to retrieve the schemes that are provided by a healthcare administrator
Request
POST /api/SchemeLookup/GetSchemesParameters
| Name | In | Type | Default | Notes |
|---|---|---|---|---|
| *request | body |
|
Responses
| Status Code | Type | Description | Samples |
|---|---|---|---|
| 200 |
|
OK |
|
| 404 | string | NotFound |
Definitions
GetAdministratorRequest
| Name | Type | Notes |
|---|---|---|
| Search | string |
AdministratorModel
| Name | Type | Notes |
|---|---|---|
| AdministratorGuid | string (uuid) | |
| Name | string | |
| Website | string | |
| PostalAddress | string | |
| PostalTown | string | |
| PostalCode | string | |
| Tel | string | |
| string |
GetPlanRequest
| Name | Type | Notes |
|---|---|---|
| PageNumber | integer (int32) |
current result page number |
| PageSize | integer (int32) |
Search result page size |
| SchemenGuid | string (uuid) |
Reference Scheme Guid |
| Search | string |
filter search request criteria |
PagedResultDto[PlanModel]
| Name | Type | Notes |
|---|---|---|
| Data |
|
|
| Total | integer (int32) | |
| PageNumber | integer (int32) | |
| PageSize | integer (int32) | |
| TotalPages | integer (int32) |
PlanModel
| Name | Type | Notes |
|---|---|---|
| PlanGuid | string (uuid) | |
| Name | string | |
| MarkUp | number (double) | |
| EffectiveDate | string (date-time) | |
| InactiveDate | string (date-time) | |
| DateCreated | string (date-time) | |
| TypeOfPlan | string | |
| PlanCode | string |
GetSchemeRequest
| Name | Type | Notes |
|---|---|---|
| PageNumber | integer (int32) |
current result page number |
| PageSize | integer (int32) |
Search result page size |
| AdministratorGuid | string (uuid) |
Reference Administrator Guid |
| Search | string |
filter search request criteria |