Jump to

• Request
• Response

Get a search result

get

/fscmRestApi/resources/11.13.18.05/publicSectorSearchDues/{SearchId}

Request

Path Parameters

• SearchId(required): string
  Unique identifier for search.

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 Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• 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.

Body ()

Root Schema : publicSectorSearchDues-item-response

Type: object

Show Source

• AddressType: string
  Title: Address Type

  Identifies the address type for the search.
• AgencyId: integer
  Title: Agency ID

  Identifies the agency id for the search.
• BusinessName: string
  Title: Business Name

  Identifies the business name for the search.
• City: string
  Title: City

  Identifies the city for the search.
• FeeLines: string
  Title: Item Lines

  Maximum Length: 255

  Identifies the fee lines return for the searched data.
• FirstName: string
  Title: First Name

  Identifies the first name for the search.
• LastName: string
  Title: Last Name

  Identifies the last name for the search.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MiddleName: string
  Title: Middle Name

  Identifies the middle name for the search.
• NameType: string
  Title: Name Type

  Identifies the name type for the search.
• PostalCode: string
  Title: Postal Code

  Identifies the postal code for the search.
• RedirectFlag: string
  Title: Redirect Mark

  Identifies the redirect request.
• ReferenceNumber: string
  Title: Reference Number

  Identifies the reference type for the search.
• ReferenceType: string
  Title: Reference Type

  Identifies the reference type for the search.
• SearchId: string
  Unique identifier for search.
• SelfServiceFlag: string
  Title: Self Service Mark

  Identifies if it is a self service request.
• StreetName: string
  Title: Street Name

  Maximum Length: 255

  Identifies the street name for the search.
• StreetNumber: string
  Title: Street Number

  Identifies the street Number for the search.
• StreetType: string
  Title: Street Type

  Maximum Length: 255

  Identifies the street type for the search.
• TransactionSource: string
  Title: Transaction Source

  Identifies the transaction source for the search.
• UnitNumber: string
  Title: Unit Number

  Identifies the unit number for the search.

{
    "type":"object",
    "properties":{
        "StreetName":{
            "title":"Street Name",
            "maxLength":255,
            "type":"string",
            "description":"Identifies the street name for the search.",
            "nullable":true,
            "x-queryable":false
        },
        "BusinessName":{
            "title":"Business Name",
            "type":"string",
            "description":"Identifies the business name for the search.",
            "nullable":true,
            "x-queryable":false
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"Identifies the agency id for the search.",
            "nullable":true,
            "x-queryable":false
        },
        "TransactionSource":{
            "title":"Transaction Source",
            "type":"string",
            "description":"Identifies the transaction source for the search.",
            "nullable":true,
            "x-queryable":false
        },
        "FirstName":{
            "title":"First Name",
            "type":"string",
            "description":"Identifies the first name for the search.",
            "nullable":true,
            "x-queryable":false
        },
        "ReferenceNumber":{
            "title":"Reference Number",
            "type":"string",
            "description":"Identifies the reference type for the search.",
            "nullable":true,
            "x-queryable":false
        },
        "PostalCode":{
            "title":"Postal Code",
            "type":"string",
            "description":"Identifies the postal code for the search.",
            "nullable":true,
            "x-queryable":false
        },
        "NameType":{
            "title":"Name Type",
            "type":"string",
            "description":"Identifies the name type for the search.",
            "nullable":true,
            "x-queryable":false
        },
        "City":{
            "title":"City",
            "type":"string",
            "description":"Identifies the city for the search.",
            "nullable":true,
            "x-queryable":false
        },
        "StreetType":{
            "title":"Street Type",
            "maxLength":255,
            "type":"string",
            "description":"Identifies the street type for the search.",
            "nullable":true,
            "x-queryable":false
        },
        "MiddleName":{
            "title":"Middle Name",
            "type":"string",
            "description":"Identifies the middle name for the search.",
            "nullable":true,
            "x-queryable":false
        },
        "ReferenceType":{
            "title":"Reference Type",
            "type":"string",
            "description":"Identifies the reference type for the search.",
            "nullable":true,
            "x-queryable":false
        },
        "SelfServiceFlag":{
            "title":"Self Service Mark",
            "type":"string",
            "description":"Identifies if it is a self service request.",
            "nullable":true,
            "x-queryable":false
        },
        "SearchId":{
            "type":"string",
            "description":"Unique identifier for search.",
            "nullable":true,
            "x-queryable":false
        },
        "FeeLines":{
            "title":"Item Lines",
            "maxLength":255,
            "type":"string",
            "description":"Identifies the fee lines return for the searched data.",
            "nullable":true,
            "x-queryable":false
        },
        "StreetNumber":{
            "title":"Street Number",
            "type":"string",
            "description":"Identifies the street Number for the search.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RedirectFlag":{
            "title":"Redirect Mark",
            "type":"string",
            "description":"Identifies the redirect request.",
            "nullable":true,
            "x-queryable":false
        },
        "UnitNumber":{
            "title":"Unit Number",
            "type":"string",
            "description":"Identifies the unit number for the search.",
            "nullable":true,
            "x-queryable":false
        },
        "LastName":{
            "title":"Last Name",
            "type":"string",
            "description":"Identifies the last name for the search.",
            "nullable":true,
            "x-queryable":false
        },
        "AddressType":{
            "title":"Address Type",
            "type":"string",
            "description":"Identifies the address type for the search.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top