Jump to

• Request
• Response

Create an application group

post

/fscmRestApi/resources/11.13.18.05/publicSectorApplGroups

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

  Identifies a public sector agency.
• ApplGroup: string
  Title: Group

  Maximum Length: 30

  The categorization for the application form.
• Description: string
  Title: Description

  Maximum Length: 100

  The description for the permit group.
• EnabledFlag: boolean
  Title: Enabled

  Maximum Length: 1

  Indicates whether the application group is available to be used or not. The default value is false.
• UseBusLicensing: string
  Title: Business Licenses

  Maximum Length: 1

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

  Maximum Length: 1

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

  Maximum Length: 1

  Indicates whether the application group will be 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 application group will be used for the professional licensing service or not. The default value is no.

{
    "type":"object",
    "properties":{
        "UsePolLicensing":{
            "title":"Professional Licenses",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the application group will be used for the professional licensing service or not. The default value is no.",
            "nullable":true
        },
        "ApplGroup":{
            "title":"Group",
            "maxLength":"30",
            "type":"string",
            "description":"The categorization for the application form.",
            "nullable":false,
            "x-hints":{
                "promptField":"Y",
                "promptList":"Y",
                "promptValue":"Y"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":"100",
            "type":"string",
            "description":"The description for the permit group.",
            "nullable":false
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"Identifies 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 application group will be used for the business licensing service or not. The default value is no.",
            "nullable":true
        },
        "UsePlanning":{
            "title":"Planning and Zoning",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the application group will be used for the planning and zoning service or not. The default value is no.",
            "nullable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the application group is available to be used or not. The default value is false.",
            "nullable":false
        },
        "UsePermitting":{
            "title":"Permits",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the application group will be used for the permits service or not. The default value is yes.",
            "nullable":true
        }
    }
}

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

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  Identifies a public sector agency.
• ApplGroup: string
  Title: Group

  Maximum Length: 30

  The categorization for the application form.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the application group.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the application group was created.
• Description: string
  Title: Description

  Maximum Length: 100

  The description for the permit group.
• EnabledFlag: boolean
  Title: Enabled

  Maximum Length: 1

  Indicates whether the application 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 application group was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the application group.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• UseBusLicensing: string
  Title: Business Licenses

  Maximum Length: 1

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

  Maximum Length: 1

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

  Maximum Length: 1

  Indicates whether the application group will be 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 application group will be used for the professional licensing service or not. The default value is no.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the application group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the application group was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the application group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"100",
            "type":"string",
            "description":"The description for the permit group.",
            "nullable":false,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"Identifies a public sector agency.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "UsePolLicensing":{
            "title":"Professional Licenses",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the application group will be used for the professional licensing service or not. The default value is no.",
            "nullable":true,
            "x-queryable":true
        },
        "ApplGroup":{
            "title":"Group",
            "maxLength":"30",
            "type":"string",
            "description":"The categorization for the application form.",
            "nullable":false,
            "x-hints":{
                "promptField":"Y",
                "promptList":"Y",
                "promptValue":"Y"
            },
            "x-queryable":true
        },
        "UseBusLicensing":{
            "title":"Business Licenses",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the application group will be 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 application group will be 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"
            }
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the application 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 application 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 application group will be used for the permits service or not. The default value is yes.",
            "nullable":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