GET Api/FDI?ActiveOnly={ActiveOnly}&IncludeDeleted={IncludeDeleted}&FDICode={FDICode}&Page={Page}&PageSize={PageSize}
Searches for an existing FDI in the system.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| ActiveOnly |
Search for Active FDI Codes only. True by default. |
boolean? |
None. |
| FDICode |
Search by FDI Code. If nothing is provided, all FDI codes will be returned. |
string |
String length: inclusive between 0 and 20 |
| IncludeDeleted |
Include deleted FDI Codes. False by default. |
boolean? |
None. |
| Page |
Specifies the page to return in the result set. Defaults to 1. |
int? |
None. |
| PageSize |
Specifies the number of records to return per-page. Defaults to 50. |
int? |
None. |
Body Parameters
None.
Response Information
Resource Description
Searches for an existing FDI in the system.
APIFDIListResponseModel| Name | Description | Type | Additional information |
|---|---|---|---|
| ErrorCode |
Name of the error condition. See ErrorCode model for details. |
ErrorCode |
None. |
| ErrorID |
Internal error identification number that uniquely identifies this specific error that occurred. |
string |
None. |
| ErrorNum |
Numeric value of the ErrorCode |
int |
None. |
| Errors |
List of errors that occurred when performing the fdi request. |
Collection of string |
None. |
| Result | APIFDIListModel |
None. |
|
| Success |
Indicates success or failure of the REST request. |
boolean |
None. |
Response Formats
application/json, text/json
Sample not available.