Jump to

• Request
• Response

Get an IVR permit condition

get

/fscmRestApi/resources/11.13.18.05/publicSectorIVRRecordConditions/{ConditionKey}

Request

Path Parameters

• ConditionKey: integer
  The unique identifier for a permit condition.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes 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 attributes 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 attributes. 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 attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorIVRRecordConditions-item

Type: object

Show Source

• AdditionalInfo(optional): string
  Maximum Length: 150

  The additional Information about the condition and resolution actions.
• Applicant(optional): integer(int64)
  The party ID of the person applying for a permit, business license, professional license, or planning and zoning conditional use permit.
• ApplicantBizProfileId(optional): integer(int64)
  The unique identifier of the applicant business profile when the applicant is a business entity.
• ApplicantProfileId(optional): integer(int64)
  The unique identifier of the applicant user profile.
• AppliedDate(optional): string(date-time)
  The date when the condition was applied.
• AttributeCategory(optional): string
  Maximum Length: 30

  The category of the application record, also the unique identifier for a record type.
• BrPreventFinalIns(optional): string
  Title: Prevent Final Inspection

  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(optional): string
  Title: Prevent Inspection Result

  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(optional): string
  Title: Prevent Inspection Schedule

  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(optional): string
  Title: Prevent Issue or Final

  Maximum Length: 1

  Indicates whether the condition prevents the permit from being issued. If the value is Y, the permit can't be issued. The default value is N.
• BrPreventNew(optional): string
  Title: Prevent Application Progress

  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 permit. The default value is N.
• BrPreventRenewal(optional): string
  Title: Prevent Renewal

  Maximum Length: 1

  Indicates whether the condition prevents the permit from being renewed. If the value is Y, the permt can't be renewed. The default value is N.
• BrPreventWorkflow(optional): string
  Title: Prevent Workflow Advancement

  Maximum Length: 1

  Indicates whether the condition prevents the workflow from advancing. If the value is Y, the worklfow can't advance. The default value is N.
• BrRestrictPayment(optional): string
  Title: Prevent Payment

  Maximum Length: 1

  Indicates whether the condition prevents a permit fee payment from being made. If the value is Y, the payment can't be made. The default value is N.
• Classification(optional): string
  Maximum Length: 3

  The record classification. The classifications can be permit, business license, professional license, or planning and zoning.
• ConditionKey(optional): integer(int64)
  The unique identifier for a permit condition.
• ConditionName(optional): string
  Maximum Length: 30

  The user-friendly name for the condition.
• Description(optional): string
  Maximum Length: 500

  The description of the condition.
• InheritFlag(optional): string
  Maximum Length: 1

  Indicates whether the condition can be inherited. The default value is false.
• links(optional): array Items
  Title: Items

  Link Relations
• LnpRecordId(optional): string
  Maximum Length: 50

  The unique identifier for an application record. This identifier is automatically generated based on the numbering rules configured for the record type.
• LnpRecordKey(optional): integer(int64)
  The unique identifier for a record. The record can be for a permit, business license, professional license, or planning and zoning, and is determined by the classification.
• Priority(optional): integer(int32)
  The priority of the condition.
• PublicFlag(optional): string
  Maximum Length: 1

  Indicates whether the condition description will be displayed to the public. The default value is false.
• Severity(optional): integer(int32)
  The severity of the condition.

{
    "properties":{
        "AdditionalInfo":{
            "maxLength":150,
            "type":"string",
            "description":"The additional Information about the condition and resolution actions."
        },
        "Applicant":{
            "format":"int64",
            "type":"integer",
            "description":"The party ID of the person applying for a permit, business license, professional license, or planning and zoning conditional use permit."
        },
        "ApplicantBizProfileId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the applicant business profile when the applicant is a business entity."
        },
        "ApplicantProfileId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the applicant user profile."
        },
        "AppliedDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the condition was applied."
        },
        "AttributeCategory":{
            "maxLength":30,
            "type":"string",
            "description":"The category of the application record, also the unique identifier for a record type."
        },
        "BrPreventFinalIns":{
            "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.",
            "title":"Prevent Final Inspection"
        },
        "BrPreventInsResult":{
            "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.",
            "title":"Prevent Inspection Result"
        },
        "BrPreventInsSched":{
            "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.",
            "title":"Prevent Inspection Schedule"
        },
        "BrPreventIssue":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the condition prevents the permit from being issued. If the value is Y, the permit can't be issued. The default value is N.",
            "title":"Prevent Issue or Final"
        },
        "BrPreventNew":{
            "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 permit. The default value is N.",
            "title":"Prevent Application Progress"
        },
        "BrPreventRenewal":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the condition prevents the permit from being renewed. If the value is Y, the permt can't be renewed. The default value is N.",
            "title":"Prevent Renewal"
        },
        "BrPreventWorkflow":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the condition prevents the workflow from advancing. If the value is Y, the worklfow can't advance. The default value is N.",
            "title":"Prevent Workflow Advancement"
        },
        "BrRestrictPayment":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the condition prevents a permit fee payment from being made. If the value is Y, the payment can't be made. The default value is N.",
            "title":"Prevent Payment"
        },
        "Classification":{
            "maxLength":3,
            "type":"string",
            "description":"The record classification. The classifications can be permit, business license, professional license, or planning and zoning."
        },
        "ConditionKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for a permit condition."
        },
        "ConditionName":{
            "maxLength":30,
            "type":"string",
            "description":"The user-friendly name for the condition."
        },
        "Description":{
            "maxLength":500,
            "type":"string",
            "description":"The description of the condition."
        },
        "InheritFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the condition can be inherited. The default value is false."
        },
        "LnpRecordId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for an application record. This identifier is automatically generated based on the numbering rules configured for the record type."
        },
        "LnpRecordKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for a record. The record can be for a permit, business license, professional license, or planning and zoning, and is determined by the classification."
        },
        "Priority":{
            "format":"int32",
            "type":"integer",
            "description":"The priority of the condition."
        },
        "PublicFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the condition description will be displayed to the public. The default value is false."
        },
        "Severity":{
            "format":"int32",
            "type":"integer",
            "description":"The severity of the condition."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top