Jump to

• Request
• Response

Create a record type display group

post

/fscmRestApi/resources/11.13.18.05/publicSectorDisplayGroups

Request

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The unique identifier of a public sector agency.
• Description: string
  Title: Display Group

  Maximum Length: 100

  The short description of the record type display group.
• DisplayGroup(required): string
  Title: Display Group ID

  Maximum Length: 30

  The unique identifier of the record type display group.
• DisplayGroupLine: array Record Type Display Group lines
  Title: Record Type Display Group lines

  The display group lines resource is used to view, create, modify, or delete a display group line. A record type display group line indicates a record type included within a display group.
• DisplayGroupSeq: integer (int32)
  Title: Display Sequence

  Indicates the sequence in which the display group should be placed.
• EnabledFlag(required): boolean
  Title: Enabled

  Maximum Length: 1

  Indicates whether the record type display group is available to be used or not. The default value is false.
• LongDescription: string
  Title: Description

  Maximum Length: 1000

  The long description of the record type display group.
• Url: string
  Title: URL

  The URL provides a link that the user can click to navigate to other pages with more information.
• UseBusLicensing: string
  Title: Business Licenses

  Maximum Length: 1

  Indicates whether the display group is used for the business licensing service or not. The default value is no.
• UsePermitting: string
  Title: Permits

  Maximum Length: 1

  Indicates whether the display group is used for the permits service or not. The default value is yes.
• UsePlanning: string
  Title: Planning and Zoning

  Maximum Length: 1

  Indicates whether the display group is used for the planning and zoning service or not. The default value is no.
• UsePolLicensing: string
  Title: Professional Licenses

  Maximum Length: 1

  Indicates whether the display group is used for the professional licensing service or not. The default value is no.

{
    "required":[
        "DisplayGroup",
        "EnabledFlag"
    ],
    "type":"object",
    "properties":{
        "UsePolLicensing":{
            "title":"Professional Licenses",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the display group is used for the professional licensing service or not. The default value is no.",
            "nullable":true
        },
        "DisplayGroup":{
            "title":"Display Group ID",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the record type display group.",
            "nullable":false
        },
        "Description":{
            "title":"Display Group",
            "maxLength":"100",
            "type":"string",
            "description":"The short description of the record type display group.",
            "nullable":true
        },
        "LongDescription":{
            "title":"Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The long description of the record type display group.",
            "nullable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier of a public sector agency.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            }
        },
        "UseBusLicensing":{
            "title":"Business Licenses",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the display group is used for the business licensing service or not. The default value is no.",
            "nullable":true
        },
        "DisplayGroupSeq":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"Indicates the sequence in which the display group should be placed.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            }
        },
        "UsePlanning":{
            "title":"Planning and Zoning",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the display group is used for the planning and zoning service or not. The default value is no.",
            "nullable":true
        },
        "DisplayGroupLine":{
            "title":"Record Type Display Group lines",
            "type":"array",
            "description":"The display group lines resource is used to view, create, modify, or delete a display group line. A record type display group line indicates a record type included within a display group.",
            "items":{
                "$ref":"#/components/schemas/publicSectorDisplayGroups-DisplayGroupLine-item-post-request"
            }
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the record type display group is available to be used or not. The default value is false.",
            "nullable":false
        },
        "Url":{
            "title":"URL",
            "type":"string",
            "description":"The URL provides a link that the user can click to navigate to other pages with more information.",
            "nullable":true,
            "x-queryable":false
        },
        "UsePermitting":{
            "title":"Permits",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the display group is used for the permits service or not. The default value is yes.",
            "nullable":true
        }
    }
}

Nested Schema : Record Type Display Group lines

Type: array

Title: Record Type Display Group lines

The display group lines resource is used to view, create, modify, or delete a display group line. A record type display group line indicates a record type included within a display group.

Show Source

• Array of: object publicSectorDisplayGroups-DisplayGroupLine-item-post-request

{
    "title":"Record Type Display Group lines",
    "type":"array",
    "description":"The display group lines resource is used to view, create, modify, or delete a display group line. A record type display group line indicates a record type included within a display group.",
    "items":{
        "$ref":"#/components/schemas/publicSectorDisplayGroups-DisplayGroupLine-item-post-request"
    }
}

Nested Schema : publicSectorDisplayGroups-DisplayGroupLine-item-post-request

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The unique identifier of a public sector agency.
• DisplayGroup: string
  Title: Display Group ID

  Maximum Length: 30

  The display group to which the group line belongs.
• DisplayOrder: integer (int64)
  Title: Display Order

  The display number for the display group line.
• RecordTypeCode: string
  Title: Record Type Code

  Maximum Length: 20

  The short name of the record type included in the display group line.
• RecordTypeId: string
  Title: Record Type ID

  Maximum Length: 30

  The unique identifier of the record type included in the display group line.

{
    "type":"object",
    "properties":{
        "RecordTypeId":{
            "title":"Record Type ID",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the record type included in the display group line.",
            "nullable":false
        },
        "DisplayGroup":{
            "title":"Display Group ID",
            "maxLength":"30",
            "type":"string",
            "description":"The display group to which the group line belongs.",
            "nullable":false
        },
        "RecordTypeCode":{
            "title":"Record Type Code",
            "maxLength":"20",
            "type":"string",
            "description":"The short name of the record type included in the display group line.",
            "nullable":false
        },
        "DisplayOrder":{
            "title":"Display Order",
            "type":"integer",
            "description":"The display number for the display group line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"20"
            }
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier of a public sector agency.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            }
        }
    }
}

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

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The unique identifier of a public sector agency.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record type display group was created.
• Description: string
  Title: Display Group

  Maximum Length: 100

  The short description of the record type display group.
• DisplayGroup: string
  Title: Display Group ID

  Maximum Length: 30

  The unique identifier of the record type display group.
• DisplayGroupLine: array Record Type Display Group lines
  Title: Record Type Display Group lines

  The display group lines resource is used to view, create, modify, or delete a display group line. A record type display group line indicates a record type included within a display group.
• DisplayGroupSeq: integer (int32)
  Title: Display Sequence

  Indicates the sequence in which the display group should be placed.
• EnabledFlag: boolean
  Title: Enabled

  Maximum Length: 1

  Indicates whether the record type display group is available to be used or not. The default value is false.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the record type display group was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LongDescription: string
  Title: Description

  Maximum Length: 1000

  The long description of the record type display group.
• Url: string
  Title: URL

  The URL provides a link that the user can click to navigate to other pages with more information.
• UseBusLicensing: string
  Title: Business Licenses

  Maximum Length: 1

  Indicates whether the display group is used for the business licensing service or not. The default value is no.
• UsePermitting: string
  Title: Permits

  Maximum Length: 1

  Indicates whether the display group is used for the permits service or not. The default value is yes.
• UsePlanning: string
  Title: Planning and Zoning

  Maximum Length: 1

  Indicates whether the display group is used for the planning and zoning service or not. The default value is no.
• UsePolLicensing: string
  Title: Professional Licenses

  Maximum Length: 1

  Indicates whether the display group is used for the professional licensing service or not. The default value is no.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record type display group was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplayGroup":{
            "title":"Display Group ID",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the record type display group.",
            "nullable":false,
            "x-queryable":true
        },
        "Description":{
            "title":"Display Group",
            "maxLength":"100",
            "type":"string",
            "description":"The short description of the record type display group.",
            "nullable":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier of a public sector agency.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "DisplayGroupSeq":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"Indicates the sequence in which the display group should be placed.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"URL",
            "type":"string",
            "description":"The URL provides a link that the user can click to navigate to other pages with more information.",
            "nullable":true,
            "x-queryable":false
        },
        "UsePolLicensing":{
            "title":"Professional Licenses",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the display group is used for the professional licensing service or not. The default value is no.",
            "nullable":true,
            "x-queryable":true
        },
        "LongDescription":{
            "title":"Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The long description of the record type display group.",
            "nullable":true,
            "x-queryable":true
        },
        "UseBusLicensing":{
            "title":"Business Licenses",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the display group is used for the business licensing service or not. The default value is no.",
            "nullable":true,
            "x-queryable":true
        },
        "UsePlanning":{
            "title":"Planning and Zoning",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the display group is used for the planning and zoning service or not. The default value is no.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DisplayGroupLine":{
            "title":"Record Type Display Group lines",
            "type":"array",
            "description":"The display group lines resource is used to view, create, modify, or delete a display group line. A record type display group line indicates a record type included within a display group.",
            "items":{
                "$ref":"#/components/schemas/publicSectorDisplayGroups-DisplayGroupLine-item-response"
            }
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the record type display group is available to be used or not. The default value is false.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record type display group was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UsePermitting":{
            "title":"Permits",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the display group is used for the permits service or not. The default value is yes.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Record Type Display Group lines

Type: array

Title: Record Type Display Group lines

The display group lines resource is used to view, create, modify, or delete a display group line. A record type display group line indicates a record type included within a display group.

Show Source

• Array of: object publicSectorDisplayGroups-DisplayGroupLine-item-response

{
    "title":"Record Type Display Group lines",
    "type":"array",
    "description":"The display group lines resource is used to view, create, modify, or delete a display group line. A record type display group line indicates a record type included within a display group.",
    "items":{
        "$ref":"#/components/schemas/publicSectorDisplayGroups-DisplayGroupLine-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 : publicSectorDisplayGroups-DisplayGroupLine-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The unique identifier of a public sector agency.
• CitizenEnabled: string
  Title: Public User Enabled

  Read Only: true

  Maximum Length: 1

  Indicates whether the record type is enabled for the public user to submit the application form. The default value is not enabled for public users.
• Classification: string
  Read Only: true

  Maximum Length: 3

  The classification of the record. The classifications can be permit, business license, professional license, or planning and zoning.
• Description: string
  Title: Description

  Read Only: true

  Maximum Length: 1000

  The long description for the record type included in the display group line.
• DisplayGroup: string
  Title: Display Group ID

  Maximum Length: 30

  The display group to which the group line belongs.
• DisplayOrder: integer (int64)
  Title: Display Order

  The display number for the display group line.
• FeeScheduleId: string
  Read Only: true

  Maximum Length: 20

  Indicates the fee schedule identifier associated with the transaction.
• isRecordTypeActive: boolean
  Read Only: true

  Indicates whether the record type is active or not. The default value is active.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RecordType: string
  Title: Record Type

  Read Only: true

  Maximum Length: 100

  The display name for the record type included in the display group line.
• RecordTypeCode: string
  Title: Record Type Code

  Maximum Length: 20

  The short name of the record type included in the display group line.
• RecordTypeId: string
  Title: Record Type ID

  Maximum Length: 30

  The unique identifier of the record type included in the display group line.
• RecordTypeState: string
  Read Only: true

  Maximum Length: 10

  Indicates the status of the record type. The default value is active.
• Url: string
  Title: URL

  Read Only: true

  The URL provides a link that the user can click to navigate to other pages with more information about 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":{
        "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
        },
        "DisplayGroup":{
            "title":"Display Group ID",
            "maxLength":"30",
            "type":"string",
            "description":"The display group to which the group line belongs.",
            "nullable":false,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The long description for the record type included in the display group line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplayOrder":{
            "title":"Display Order",
            "type":"integer",
            "description":"The display number for the display group line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"20"
            },
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier of a public sector agency.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "RecordTypeState":{
            "maxLength":"10",
            "type":"string",
            "description":"Indicates the status of the record type. The default value is active.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CitizenEnabled":{
            "title":"Public User Enabled",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the record type is enabled for the public user to submit the application form. The default value is not enabled for public users.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "isRecordTypeActive":{
            "type":"boolean",
            "description":"Indicates whether the record type is active or not. The default value is active.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Url":{
            "title":"URL",
            "type":"string",
            "description":"The URL provides a link that the user can click to navigate to other pages with more information about the record type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordTypeCode":{
            "title":"Record Type Code",
            "maxLength":"20",
            "type":"string",
            "description":"The short name of the record type included in the display group line.",
            "nullable":false,
            "x-queryable":true
        },
        "RecordType":{
            "title":"Record Type",
            "maxLength":"100",
            "type":"string",
            "description":"The display name for the record type included in the display group line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Classification":{
            "maxLength":"3",
            "type":"string",
            "description":"The classification of the record. The classifications can be permit, business license, professional license, or planning and zoning.",
            "nullable":false,
            "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
        },
        "RecordTypeId":{
            "title":"Record Type ID",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the record type included in the display group line.",
            "nullable":false,
            "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":"Indicates the fee schedule identifier associated with the transaction.",
            "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."
        }
    }
}

Links

DisplayGroupLine

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorDisplayGroups/{publicSectorDisplayGroupsUniqID}/child/DisplayGroupLine

Parameters:

• publicSectorDisplayGroupsUniqID: $request.path.publicSectorDisplayGroupsUniqID

The display group lines resource is used to view, create, modify, or delete a display group line. A record type display group line indicates a record type included within a display group.

Back to Top