Jump to

• Request
• Response

Get all IVR record types

get

/fscmRestApi/resources/11.13.18.05/publicSectorIVRRecordTypes

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 type that matches the specified primary key criteria.
    Finder Variables:
    • RecordTypeId; string; The unique identifier for the record type.
  • RowFinder: Finds an IVR record type using RECORD_TYPE_ID and 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 a permit, business license, or planning and zoning, and is determined by the classification.
    • RECORD_TYPE_ID; string; The unique identifier for the record type.
• 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:
  

  • AgencyId; integer; The identifier for a public sector agency associated with the record type.
  • ApplGroup; string; The highest level of categorization to which the record type belongs.
  • BillType; string; The bill type associated with the record type.
  • Category; string; The record type category.
  • CitizenEnabled; string; Indicates whether public users can submit an application form with this record type. The default value is not enabled for public users.
  • Classification; string; The classification of the record type.
  • DepartmentId; string; The department associated with the record type.
  • Description; string; The long description for the record type.
  • DocGroupId; string; Indicates the document group, which is defined by a set of attachment document categories.
  • FeeScheduleId; string; The identifier for the fee schedule associated with the record type.
  • HearingOption; string; Indicates whether a public hearing is applicable for the transaction type.
  • InspectionGroup; string; The group of inspections if multiple inspections are required for the record type.
  • InspectionGroupAmend; string; The group of inspections for business license amendments if multiple inspections are required for the record type.
  • InspectionGroupRenew; string; The group of inspections for business license renewals if multiple inspections are required for the record type.
  • LnpRecordId; string; The unique identifier for an application record. This identifier is automatically generated based on the rules configured for the record type.
  • LnpRecordKey; integer; The unique identifier for an application record. The record is for a permit, business license, professional license, or planning and zoning, and is determined by the classification.
  • PlanReview; string; Indicates the type of plan review that can be created for the transaction type.The plan review type can be manual or electronic document review.
  • RecordType; string; The user-friendly name for the record type.
  • RecordTypeCode; string; The unique alphanumeric code or short name for the record type.
  • RecordTypeId; string; The unique identifier for the record type.
  • RecordTypeState; string; The status of the record type. The default value is preliminary.
  • RenewalRuleId; string; The rule used when renewing the record type.
  • RuleId; string; The autonumber rule used to create the identifier for record transactions.
  • Subcategory; string; The record type subcategory.
  • Subclassification; string; The subclassification for the transaction type, which indicates that the pre-application process is included in addition to the hearing process.
  • TermsUseId; string; The terms and use ID associated with the record type.
  • ValidFromDate; string; The date when the record type is valid to use.
  • ValidToDate; string; The date when the record type is no longer valid to use.
• 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 : publicSectorIVRRecordTypes

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/publicSectorIVRRecordTypes-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 publicSectorIVRRecordTypes-item-response

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

Type: object

Show Source

• AgencyId: integer
  Read Only: true

  The identifier for a public sector agency associated with the record type.
• ApplGroup: string
  Read Only: true

  Maximum Length: 30

  The highest level of categorization to which the record type belongs.
• BillType: string
  Read Only: true

  Maximum Length: 15

  The bill type associated with the record type.
• Category: string
  Read Only: true

  Maximum Length: 30

  The record type category.
• CitizenEnabled: string
  Read Only: true

  Maximum Length: 1

  Indicates whether public users can submit an application form with this record type. The default value is not enabled for public users.
• Classification: string
  Read Only: true

  Maximum Length: 3

  The classification of the record type.
• DepartmentId: string
  Read Only: true

  Maximum Length: 30

  The department associated with the record type.
• Description: string
  Read Only: true

  Maximum Length: 1000

  The long description for the record type.
• DocGroupId: string
  Read Only: true

  Maximum Length: 30

  Indicates the document group, which is defined by a set of attachment document categories.
• FeeScheduleId: string
  Read Only: true

  Maximum Length: 20

  The identifier for the fee schedule associated with the record type.
• HearingOption: string
  Read Only: true

  Maximum Length: 10

  Indicates whether a public hearing is applicable for the transaction type.
• InspectionGroup: string
  Read Only: true

  Maximum Length: 15

  The group of inspections if multiple inspections are required for the record type.
• InspectionGroupAmend: string
  Read Only: true

  Maximum Length: 15

  The group of inspections for business license amendments if multiple inspections are required for the record type.
• InspectionGroupRenew: string
  Read Only: true

  Maximum Length: 15

  The group of inspections for business license renewals if multiple inspections are required for the record type.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LnpRecordId: string
  Read Only: true

  Maximum Length: 50

  The unique identifier for an application record. This identifier is automatically generated based on the rules configured for the record type.
• LnpRecordKey: integer (int64)
  Read Only: true

  The unique identifier for an application record. The record is for a permit, business license, professional license, or planning and zoning, and is determined by the classification.
• PlanReview: string
  Read Only: true

  Maximum Length: 10

  Indicates the type of plan review that can be created for the transaction type.The plan review type can be manual or electronic document review.
• RecordType: string
  Read Only: true

  Maximum Length: 100

  The user-friendly name for the record type.
• RecordTypeCode: string
  Read Only: true

  Maximum Length: 20

  The unique alphanumeric code or short name for the record type.
• RecordTypeId: string
  Read Only: true

  Maximum Length: 30

  The unique identifier for the record type.
• RecordTypeState: string
  Read Only: true

  Maximum Length: 10

  The status of the record type. The default value is preliminary.
• RenewalRuleId: string
  Read Only: true

  Maximum Length: 20

  The rule used when renewing the record type.
• RuleId: string
  Read Only: true

  Maximum Length: 20

  The autonumber rule used to create the identifier for record transactions.
• Subcategory: string
  Read Only: true

  Maximum Length: 30

  The record type subcategory.
• Subclassification: string
  Read Only: true

  Maximum Length: 10

  The subclassification for the transaction type, which indicates that the pre-application process is included in addition to the hearing process.
• TermsUseId: string
  Read Only: true

  Maximum Length: 15

  The terms and use ID associated with the record type.
• ValidFromDate: string (date)
  Read Only: true

  The date when the record type is valid to use.
• ValidToDate: string (date)
  Read Only: true

  The date when the record type is no longer valid to use.

{
    "type":"object",
    "properties":{
        "Subclassification":{
            "maxLength":"10",
            "type":"string",
            "description":"The subclassification for the transaction type, which indicates that the pre-application process is included in addition to the hearing process.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Category":{
            "maxLength":"30",
            "type":"string",
            "description":"The record type category.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":"1000",
            "type":"string",
            "description":"The long description for the record type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The identifier for a public sector agency associated with the record type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanReview":{
            "maxLength":"10",
            "type":"string",
            "description":"Indicates the type of plan review that can be created for the transaction type.The plan review type can be manual or electronic document review.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordTypeState":{
            "maxLength":"10",
            "type":"string",
            "description":"The status of the record type. The default value is preliminary.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CitizenEnabled":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether public users can submit an application form with this record type. The default value is not enabled for public users.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RuleId":{
            "maxLength":"20",
            "type":"string",
            "description":"The autonumber rule used to create the identifier for record transactions.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RenewalRuleId":{
            "maxLength":"20",
            "type":"string",
            "description":"The rule used when renewing the record type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordTypeCode":{
            "maxLength":"20",
            "type":"string",
            "description":"The unique alphanumeric code or short name for the record type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordType":{
            "maxLength":"100",
            "type":"string",
            "description":"The user-friendly name for the record type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Classification":{
            "maxLength":"3",
            "type":"string",
            "description":"The classification of the record type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordTypeId":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier for the record type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "HearingOption":{
            "maxLength":"10",
            "type":"string",
            "description":"Indicates whether a public hearing is applicable for the transaction type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FeeScheduleId":{
            "maxLength":"20",
            "type":"string",
            "description":"The identifier for the fee schedule associated with the record type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionGroupAmend":{
            "maxLength":"15",
            "type":"string",
            "description":"The group of inspections for business license amendments if multiple inspections are required for the record type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionGroup":{
            "maxLength":"15",
            "type":"string",
            "description":"The group of inspections if multiple inspections are required for the record type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TermsUseId":{
            "maxLength":"15",
            "type":"string",
            "description":"The terms and use ID associated with the record type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BillType":{
            "maxLength":"15",
            "type":"string",
            "description":"The bill type associated with the record type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ValidToDate":{
            "type":"string",
            "description":"The date when the record type is no longer valid to use.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordId":{
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier for an application record. This identifier is automatically generated based on the rules configured for the record type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InspectionGroupRenew":{
            "maxLength":"15",
            "type":"string",
            "description":"The group of inspections for business license renewals if multiple inspections are required for the record type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"The unique identifier for an application record. The record is for a permit, business license, professional license, or planning and zoning, and is determined by the classification.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ApplGroup":{
            "maxLength":"30",
            "type":"string",
            "description":"The highest level of categorization to which the record type belongs.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Subcategory":{
            "maxLength":"30",
            "type":"string",
            "description":"The record type subcategory.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ValidFromDate":{
            "type":"string",
            "description":"The date when the record type is valid to use.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DocGroupId":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the document group, which is defined by a set of attachment document categories.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DepartmentId":{
            "maxLength":"30",
            "type":"string",
            "description":"The department associated with the record type.",
            "nullable":true,
            "readOnly":true,
            "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