Jump to

• Request
• Response

Get all IVR record conditions

get

/fscmRestApi/resources/11.13.18.05/publicSectorIVRRecordConditions

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:
  
  

  • PrimaryKey: Finds an IVR record condition that matches the specified primary key criteria.
    Finder Variables:
    • ConditionKey; integer; The unique identifier for a record condition.
  • RowFinder: Finds an IVR record condition by LNP_RECORD_KEY.
    Finder Variables:
    • IVR_ACCESS_CODE; string; The IVR password associated with the record's applicant user profile, or the user profile of any of the record's registered contacts.
    • LNP_RECORD_KEY; integer; The unique identifier for an application record. The record is for permits, business licenses, or planning and zoning, and is determined by the classification.
• 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
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AdditionalInfo; string; The additional Information about the condition and resolution actions.
  • Applicant; integer; The party ID of the person applying for a permit, business license, professional license, or planning and zoning conditional use permit.
  • ApplicantBizProfileId; integer; The unique identifier of the applicant business profile when the applicant is a business entity.
  • ApplicantProfileId; integer; The unique identifier of the applicant user profile.
  • AppliedDate; string; The date when the condition was applied.
  • AttributeCategory; string; The category of the record, also the unique identifier for a record type.
  • BrPreventAmendmentFlag; string; Indicates whether the condition is allowed to be prevented by the Prevent Amendment process.
  • BrPreventFinalIns; string; 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; 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; 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; 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; 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; Indicates whether the condition prevents an existing business from being renewed for a case on hold. The default value is N.
  • BrPreventWorkflow; string; 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; 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; The record classification. The classifications can be permits, business licenses, or planning and zoning.
  • ConditionKey; integer; The unique identifier for a record condition.
  • ConditionName; string; The user-friendly name for the condition.
  • Description; string; The description of the condition.
  • InheritFlag; string; Indicates whether the condition can be inherited. The default value is false.
  • LicensePeriod; string; The reporting period that applies to the business license.
  • LnpRecordId; string; A unique identifier for a record. This identifier is automatically generated based on the numbering rules configured for the record type.
  • LnpRecordKey; integer; 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; The unique subtype value to identify the subtype of a record. For example, an address within a parcel.
  • Priority; integer; The priority of the condition.
  • PublicFlag; string; Indicates whether the condition description will be displayed to the public. The default value is false.
  • Severity; integer; The severity of the condition.
  • VersionType; string; The activity for business license type for which options are set, such as origination, amendment, or renewal.
• 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 : publicSectorIVRRecordConditions

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/publicSectorIVRRecordConditions-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"Inspections",
        "usage":"BusinessObject",
        "group":"psc"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorIVRRecordConditions-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/publicSectorIVRRecordConditions-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 : publicSectorIVRRecordConditions-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "Description":{
            "maxLength":"500",
            "type":"string",
            "description":"The description of the condition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BrPreventInsSched":{
            "title":"Prevent Inspection Schedule",
            "maxLength":"1",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InheritFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the condition can be inherited. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AttributeCategory":{
            "maxLength":"30",
            "type":"string",
            "description":"The category of the record, also the unique identifier for a record type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ConditionName":{
            "maxLength":"30",
            "type":"string",
            "description":"The user-friendly name for the condition.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BrPreventWorkflow":{
            "title":"Prevent Workflow Advancement",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the condition prevents the workflow from advancing. If the value is Y, the workflow can't advance. The default value is N.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectSubType":{
            "maxLength":"3",
            "type":"string",
            "description":"The unique subtype value to identify the subtype of a record. For example, an address within a parcel.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Classification":{
            "maxLength":"3",
            "type":"string",
            "description":"The record classification. The classifications can be permits, business licenses, or planning and zoning.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LicensePeriod":{
            "maxLength":"100",
            "type":"string",
            "description":"The reporting period that applies to the business license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PublicFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the condition description will be displayed to the public. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BrPreventNew":{
            "title":"Prevent Application Progress",
            "maxLength":"1",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AppliedDate":{
            "type":"string",
            "description":"The date when the condition was applied.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordId":{
            "maxLength":"50",
            "type":"string",
            "description":"A unique identifier for a record. This identifier is automatically generated based on the numbering rules configured for the record type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AdditionalInfo":{
            "maxLength":"150",
            "type":"string",
            "description":"The additional Information about the condition and resolution actions.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BrPreventAmendmentFlag":{
            "title":"Business License Amendment",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the condition is allowed to be prevented by the Prevent Amendment process.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantProfileId":{
            "type":"integer",
            "description":"The unique identifier of the applicant user profile.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BrPreventIssue":{
            "title":"Prevent Issue or Final",
            "maxLength":"1",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Priority":{
            "type":"integer",
            "description":"The priority of the condition.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"1"
            },
            "x-queryable":true
        },
        "BrPreventRenewal":{
            "title":"Business License Renewal",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the condition prevents an existing business from being renewed for a case on hold. The default value is N.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Severity":{
            "type":"integer",
            "description":"The severity of the condition.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"1"
            },
            "x-queryable":true
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "VersionType":{
            "maxLength":"1",
            "type":"string",
            "description":"The activity for business license type for which options are set, such as origination, amendment, or renewal.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantBizProfileId":{
            "type":"integer",
            "description":"The unique identifier of the applicant business profile when the applicant is a business entity.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BrPreventFinalIns":{
            "title":"Prevent Final Inspection",
            "maxLength":"1",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BrPreventInsResult":{
            "title":"Prevent Inspection Result",
            "maxLength":"1",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BrRestrictPayment":{
            "title":"Prevent Payment",
            "maxLength":"1",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ConditionKey":{
            "type":"integer",
            "description":"The unique identifier for a record condition.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Applicant":{
            "type":"integer",
            "description":"The party ID of the person applying for a permit, business license, professional license, or planning and zoning conditional use permit.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        }
    }
}

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