Get a search result
get
/fscmRestApi/resources/11.13.18.05/publicSectorSearchDues/{SearchId}
Request
Path Parameters
-
SearchId(required): string
Unique identifier for search assigned by the system.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : publicSectorSearchDues-item-response
Type:
Show Source
object
-
AddressType: string
Identifies the type of address provided in the search request.
-
AgencyId: integer
Identifies the agency identifier for which the search results should be returned.
-
BusinessName: string
Identifies the business name for the name type provided in the search request.
-
City: string
Identifies the city for the address type provided in the search request.
-
FeeLines: string
Maximum Length:
255
Identifies the fee lines returned for the search request. -
FirstName: string
Identifies the first name for the name type provided in the search request.
-
LastName: string
Identifies the last name for the name type provided in the search request.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MiddleName: string
Identifies the middle name for the name type provided in the search request.
-
NameType: string
Identifies the type of name provided in the search request.
-
PostalCode: string
Identifies the postal code for the address type provided in the search request.
-
RedirectFlag: string
Identifies whether search request was initiated after a page redirect.
-
ReferenceNumber: string
Identifies the transaction reference for the reference type provided in the search request.
-
ReferenceType: string
Identifies the type of reference provided in the search request.
-
SearchId: string
Unique identifier for search assigned by the system.
-
SelfServiceFlag: string
Identifies whether search request is initiated by a self service user.
-
StreetName: string
Maximum Length:
255
Identifies the street name for the address type provided in the search request. -
StreetNumber: string
Identifies the street number for the address type provided in the search request.
-
StreetType: string
Maximum Length:
255
Identifies the street type for the address type provided in the search request. -
TransactionSource: string
Identifies the transaction source that should return the search results.
-
UnitNumber: string
Identifies the unit number for the address type provided in the search request.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.