Jump to

• Request
• Response

Get all search result

get

/fscmRestApi/resources/11.13.18.05/publicSectorSearchDues

Request

Query Parameters

• 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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • AddressFinder: Finds fee item by AddressFinder.
    Finder Variables:
    • byAddressType; string; Finds fee item using AddressFinder by AddressType.
    • byAgencyId; integer; Finds fee item using AddressFinder by AgencyId.
    • byBusinessName; string; Finds fee item using AddressFinder by Business Name.
    • byLastName; string; Finds fee item using AddressFinder by Last Name.
    • byNameType; string; Finds fee item using AddressFinder by NameType.
    • byRedirectFlag; string; Finds fee item using AddressFinder by RedirectFlag.
    • byReferenceNumber; string; Finds fee item using AddressFinder by ReferenceNumber.
    • byReferenceType; string; Finds fee item using AddressFinder by ReferenceType.
    • bySelfServiceFlag; string; Finds fee item using AddressFinder by SelfServiceFlag.
    • byStreetName; string; Finds fee item using AddressFinder by StreetName.
    • byStreetNumber; string; Finds fee item using AddressFinder by StreetNumber.
    • byTransactionSource; string; Finds fee item using AddressFinder by TransactionSource.
  • BusinessNameFinder: Finds fee item by BusinessName.
    Finder Variables:
    • byAddressType; string; Finds fee item using BusinessFinder by AddressType.
    • byAgencyId; integer; Finds fee item using BusinessFinder by Agency Id.
    • byBusinessName; string; Finds fee item using BusinessFinder by Business Name.
    • byNameType; string; Finds fee item using BusinessFinder by NmaeType.
    • byRedirectFlag; string; Finds fee item using BusinessFinder by RedirectFlag.
    • byReferenceNumber; string; Finds fee item using BusinessFinder by Reference Number.
    • byReferenceType; string; Finds fee item using BusinessFinder by Reference Type.
    • bySelfServiceFlag; string; Finds fee item using BusinessFinder bySelfServiceFlag.
    • byStreetName; string; Finds fee item using BusinessFinder by StreetName.
    • byStreetNumber; string; Finds fee item using BusinessFinder by StreetNumber.
    • byTransactionSource; string; Finds fee item using BusinessFinder by TransactionSource.
  • PersonNameFinder: Finds fee items by PersonName.
    Finder Variables:
    • byAddressType; string; Finds fee items using PersonNameFinder by AddressType.
    • byAgencyId; integer; Finds fee items using PersonNameFinder by AgencyId.
    • byFirstName; string; Finds fee items using PersonNameFinder by FirstName.
    • byLastName; string; Finds fee items using PersonNameFinder by LastName.
    • byMiddleName; string; Finds fee items using PersonNameFinder by MiddleName.
    • byNameType; string; Finds fee items using PersonNameFinder by NameType.
    • byRedirectFlag; string; Finds fee items using PersonNameFinder by RedirectFlag.
    • byReferenceNumber; string; Finds fee items using PersonNameFinder by ReferenceNumber.
    • byReferenceType; string; Finds fee items using PersonNameFinder by ReferenceType.
    • bySelfServiceFlag; string; Finds fee items using PersonNameFinder by SelfServiceFlag.
    • byStreetName; string; Finds fee items using PersonNameFinder by StreetName.
    • byStreetNumber; string; Finds fee items using PersonNameFinder by StreetNumber.
    • byTransactionSource; string; Finds fee items using PersonNameFinder by TransactionSource.
  • PrimaryKey: Finds fee items using primary key.
    Finder Variables:
    • SearchId; string; Finds fee items usiing unique identifier searchId.
  • ReferenceFinder: Finds fee items by reference finder.
    Finder Variables:
    • byAgencyId; integer; Finds fee items using reference finder by AgencyId.
    • byBusinessName; string; Finds fee items using reference finder by BusinessName.
    • byLastName; string; Finds fee items using reference finder by LastName.
    • byNameType; string; Finds fee items using reference finder by NameType.
    • byRedirectFlag; string; Finds fee items using reference finder by RedirectFlag.
    • byReferenceNumber; string; Finds fee items using reference finder by ReferenceNumber.
    • byReferenceType; string; Finds fee items using reference finder by ReferenceType.
    • bySelfServiceFlag; string; Finds fee items using reference finder by SelfServiceFlag.
    • byTransactionSource; string; Finds fee items using reference finder by TransactionSource.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• 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
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/publicSectorSearchDues-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"BillingandPayment",
        "usage":"BusinessObject",
        "group":"psc"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorSearchDues-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/publicSectorSearchDues-item-response"
    }
}

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 : publicSectorSearchDues-item-response

Type: object

Show Source

• AddressType: string
  Title: Address Type

  Identifies the type of address provided in the search request.
• AgencyId: integer
  Title: Agency ID

  Identifies the agency identifier for which the search results should be returned.
• BusinessName: string
  Title: Business Name

  Identifies the business name for the name type provided in the search request.
• City: string
  Title: City

  Identifies the city for the address type provided in the search request.
• FeeLines: string
  Title: Item Lines

  Maximum Length: 255

  Identifies the fee lines returned for the search request.
• FirstName: string
  Title: First Name

  Identifies the first name for the name type provided in the search request.
• LastName: string
  Title: Last Name

  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
  Title: Middle Name

  Identifies the middle name for the name type provided in the search request.
• NameType: string
  Title: Name Type

  Identifies the type of name provided in the search request.
• PostalCode: string
  Title: Postal Code

  Identifies the postal code for the address type provided in the search request.
• RedirectFlag: string
  Title: Redirect Mark

  Identifies whether search request was initiated after a page redirect.
• ReferenceNumber: string
  Title: Reference Number

  Identifies the transaction reference for the reference type provided in the search request.
• ReferenceType: string
  Title: Reference Type

  Identifies the type of reference provided in the search request.
• SearchId: string
  Unique identifier for search assigned by the system.
• SelfServiceFlag: string
  Title: Self Service Mark

  Identifies whether search request is initiated by a self service user.
• StreetName: string
  Title: Street Name

  Maximum Length: 255

  Identifies the street name for the address type provided in the search request.
• StreetNumber: string
  Title: Street Number

  Identifies the street number for the address type provided in the search request.
• StreetType: string
  Title: Street Type

  Maximum Length: 255

  Identifies the street type for the address type provided in the search request.
• TransactionSource: string
  Title: Transaction Source

  Identifies the transaction source that should return the search results.
• UnitNumber: string
  Title: Unit Number

  Identifies the unit number for the address type provided in the search request.

{
    "type":"object",
    "properties":{
        "StreetName":{
            "title":"Street Name",
            "maxLength":"255",
            "type":"string",
            "description":"Identifies the street name for the address type provided in the search request.",
            "nullable":true,
            "x-queryable":false
        },
        "BusinessName":{
            "title":"Business Name",
            "type":"string",
            "description":"Identifies the business name for the name type provided in the search request.",
            "nullable":true,
            "x-queryable":false
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"Identifies the agency identifier for which the search results should be returned.",
            "nullable":true,
            "x-queryable":false
        },
        "TransactionSource":{
            "title":"Transaction Source",
            "type":"string",
            "description":"Identifies the transaction source that should return the search results.",
            "nullable":true,
            "x-queryable":false
        },
        "FirstName":{
            "title":"First Name",
            "type":"string",
            "description":"Identifies the first name for the name type provided in the search request.",
            "nullable":true,
            "x-queryable":false
        },
        "ReferenceNumber":{
            "title":"Reference Number",
            "type":"string",
            "description":"Identifies the transaction reference for the reference type provided in the search request.",
            "nullable":true,
            "x-queryable":false
        },
        "PostalCode":{
            "title":"Postal Code",
            "type":"string",
            "description":"Identifies the postal code for the address type provided in the search request.",
            "nullable":true,
            "x-queryable":false
        },
        "NameType":{
            "title":"Name Type",
            "type":"string",
            "description":"Identifies the type of name provided in the search request.",
            "nullable":true,
            "x-queryable":false
        },
        "City":{
            "title":"City",
            "type":"string",
            "description":"Identifies the city for the address type provided in the search request.",
            "nullable":true,
            "x-queryable":false
        },
        "StreetType":{
            "title":"Street Type",
            "maxLength":"255",
            "type":"string",
            "description":"Identifies the street type for the address type provided in the search request.",
            "nullable":true,
            "x-queryable":false
        },
        "MiddleName":{
            "title":"Middle Name",
            "type":"string",
            "description":"Identifies the middle name for the name type provided in the search request.",
            "nullable":true,
            "x-queryable":false
        },
        "ReferenceType":{
            "title":"Reference Type",
            "type":"string",
            "description":"Identifies the type of reference provided in the search request.",
            "nullable":true,
            "x-queryable":false
        },
        "SelfServiceFlag":{
            "title":"Self Service Mark",
            "type":"string",
            "description":"Identifies whether search request is initiated by a self service user.",
            "nullable":true,
            "x-queryable":false
        },
        "SearchId":{
            "type":"string",
            "description":"Unique identifier for search assigned by the system.",
            "nullable":true,
            "x-queryable":false
        },
        "FeeLines":{
            "title":"Item Lines",
            "maxLength":"255",
            "type":"string",
            "description":"Identifies the fee lines returned for the search request.",
            "nullable":true,
            "x-queryable":false
        },
        "StreetNumber":{
            "title":"Street Number",
            "type":"string",
            "description":"Identifies the street number for the address type provided in the search request.",
            "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 whether search request was initiated after a page redirect.",
            "nullable":true,
            "x-queryable":false
        },
        "UnitNumber":{
            "title":"Unit Number",
            "type":"string",
            "description":"Identifies the unit number for the address type provided in the search request.",
            "nullable":true,
            "x-queryable":false
        },
        "LastName":{
            "title":"Last Name",
            "type":"string",
            "description":"Identifies the last name for the name type provided in the search request.",
            "nullable":true,
            "x-queryable":false
        },
        "AddressType":{
            "title":"Address Type",
            "type":"string",
            "description":"Identifies the type of address provided in the search request.",
            "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