GET api/miscellaneous/search?Code={Code}&AllItems={AllItems}&ResultsLimit={ResultsLimit}
Get miscellaneous values based on search parameters.
Requires Authorisation
The api request must supply authenticated token in a custom variable in the request header. The custom variable name is configured in web.config. The default name of the custom variable is “X-Fern-Token”.
Requires Api License and User Access
The api requires license and user permission for API ID, GETapi/miscellaneous/search. The user permission can be defined on User Settings screen in Abacus. For license, please contact Fern manager.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| Code |
Unique code of a miscellaneous item. |
ListTypes | Required. |
| AllItems |
Indicates whether to return all miscellaneous items or not for specified Code. |
boolean | |
| ResultsLimit |
Limit the number of results found. |
integer | If no value is passed then it will return all the results. If 0 is passed, then no results will be returned. |
Body Parameters
None.
Response Information
Response Codes
Success Status:
- OK (200), please see resource description below.
Failed Status(es):
Resource Description
Array of miscellaneous values based on serach parameters.
Collection of MiscellaneousDto| Name | Description | Type | Additional information |
|---|---|---|---|
| ValueMember |
Key value of a Miscellaneous Item. |
integer | |
| DisplayMember |
Display value of a miscellaneous item. |
string |
Response Formats
application/json, text/json
[
{
"valueMember": 1,
"displayMember": "sample string 1"
},
{
"valueMember": 1,
"displayMember": "sample string 1"
}
]
application/xml, text/xml
<ArrayOfMiscellaneousDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fern.Abacus.ObjectModel.Dto">
<MiscellaneousDto>
<DisplayMember>sample string 1</DisplayMember>
<ValueMember>1</ValueMember>
</MiscellaneousDto>
<MiscellaneousDto>
<DisplayMember>sample string 1</DisplayMember>
<ValueMember>1</ValueMember>
</MiscellaneousDto>
</ArrayOfMiscellaneousDto>