Get an IVR record condition
get
/fscmRestApi/resources/11.13.18.05/publicSectorIVRRecordConditions/{ConditionKey}
Request
Path Parameters
-
ConditionKey(required): integer(int64)
The unique identifier for a record condition.
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 : publicSectorIVRRecordConditions-item-response
Type:
Show Source
object
-
AdditionalInfo: string
Read Only:
true
Maximum Length:150
The additional Information about the condition and resolution actions. -
Applicant: integer
(int64)
Read Only:
true
The party ID of the person applying for a permit, business license, professional license, or planning and zoning conditional use permit. -
ApplicantBizProfileId: integer
(int64)
Read Only:
true
The unique identifier of the applicant business profile when the applicant is a business entity. -
ApplicantProfileId: integer
(int64)
Read Only:
true
The unique identifier of the applicant user profile. -
AppliedDate: string
(date-time)
Read Only:
true
The date when the condition was applied. -
AttributeCategory: string
Read Only:
true
Maximum Length:30
The category of the record, also the unique identifier for a record type. -
BrPreventAmendmentFlag: string
Title:
Business License Amendment
Read Only:true
Maximum Length:1
Indicates whether the condition is allowed to be prevented by the Prevent Amendment process. -
BrPreventFinalIns: string
Title:
Prevent Final Inspection
Read Only:true
Maximum Length:1
Indicates whether the condition prevents scheduling and the resulting inspection for a case on hold. If the value is Y, the scheduling and inspection can't be made. The default value is N. -
BrPreventInsResult: string
Title:
Prevent Inspection Result
Read Only:true
Maximum Length:1
Indicates whether the condition prevents the inspector from submitting results. If the value is Y, the inspection results can't be added. The default value is N. -
BrPreventInsSched: string
Title:
Prevent Inspection Schedule
Read Only:true
Maximum Length:1
Indicates whether the condition prevents an inspection from being scheduled. If the value is Y, the inspection can't be scheduled. The default value is N. -
BrPreventIssue: string
Title:
Prevent Issue or Final
Read Only:true
Maximum Length:1
Indicates whether the condition prevents the record from being issued. If the value is Y, the record can't be issued. The default value is N. -
BrPreventNew: string
Title:
Prevent Application Progress
Read Only:true
Maximum Length:1
Indicates whether the condition prevents a new business from being added. If the value is Y, a new business can't be added to the record. The default value is N. -
BrPreventRenewal: string
Title:
Business License Renewal
Read Only:true
Maximum Length:1
Indicates whether the condition prevents an existing business from being renewed for a case on hold. The default value is N. -
BrPreventWorkflow: string
Title:
Prevent Workflow Advancement
Read Only:true
Maximum Length:1
Indicates whether the condition prevents the workflow from advancing. If the value is Y, the workflow can't advance. The default value is N. -
BrRestrictPayment: string
Title:
Prevent Payment
Read Only:true
Maximum Length:1
Indicates whether the condition prevents a record fee payment from being made. If the value is Y, the payment can't be made. The default value is N. -
Classification: string
Read Only:
true
Maximum Length:3
The record classification. The classifications can be permits, business licenses, or planning and zoning. -
ConditionKey: integer
(int64)
Read Only:
true
The unique identifier for a record condition. -
ConditionName: string
Read Only:
true
Maximum Length:30
The user-friendly name for the condition. -
Description: string
Read Only:
true
Maximum Length:500
The description of the condition. -
InheritFlag: string
Read Only:
true
Maximum Length:1
Indicates whether the condition can be inherited. The default value is false. -
LicensePeriod: string
Read Only:
true
Maximum Length:100
The reporting period that applies to the business license. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LnpRecordId: string
Read Only:
true
Maximum Length:50
A unique identifier for a record. This identifier is automatically generated based on the numbering rules configured for the record type. -
LnpRecordKey: integer
(int64)
Read Only:
true
The unique identifier for an application record. The record can be for permits, business licenses, or planning and zoning, and is determined by the classification. -
ObjectSubType: string
Read Only:
true
Maximum Length:3
The unique subtype value to identify the subtype of a record. For example, an address within a parcel. -
Priority: integer
(int32)
Read Only:
true
The priority of the condition. -
PublicFlag: string
Read Only:
true
Maximum Length:1
Indicates whether the condition description will be displayed to the public. The default value is false. -
Severity: integer
(int32)
Read Only:
true
The severity of the condition. -
VersionType: string
Read Only:
true
Maximum Length:1
The activity for business license type for which options are set, such as origination, amendment, or renewal.
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.