Jump to

• Request
• Response

Create a plan reviewer department

post

/fscmRestApi/resources/11.13.18.05/publicSectorPlanReviewerDepartments

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 agency identifier of the public sector entity to which this plan reviewer department applies.
• Department: string
  Title: Department

  Maximum Length: 25

  The value that will be displayed for a plan reviewer department. This value is user-defined.
• DepartmentId: string
  Title: Department ID

  Maximum Length: 30

  The unique identifier for a plan reviewer department.
• DepartmentLeadId: integer (int64)
  Title: Department Lead

  The unique identifier for the plan reviewer department lead.
• Description: string
  Title: Description

  Maximum Length: 500

  The long description value for a plan reviewer department.
• EnabledFlag: string
  Title: Enabled

  Maximum Length: 1

  Indicates whether the plan reviewer department is enabled. If true, the plan reviewer department is enabled and is a valid value that can be selected as a plan reviewer department. If false, the plan reviewer department is not a valid value and can't be selected as a plan reviewer department. The default value is true.
• UsePermitting: boolean
  Title: Permits

  Maximum Length: 1

  Indicates whether the plan reviewer department is applicable to the Permit classification.
• UsePlanning: boolean
  Title: Planning and Zoning

  Maximum Length: 1

  Indicates whether the plan reviewer department is applicable to the Planning and Zoning classification.

{
    "type":"object",
    "properties":{
        "Department":{
            "title":"Department",
            "maxLength":"25",
            "type":"string",
            "description":"The value that will be displayed for a plan reviewer department. This value is user-defined.",
            "nullable":false
        },
        "Description":{
            "title":"Description",
            "maxLength":"500",
            "type":"string",
            "description":"The long description value for a plan reviewer department.",
            "nullable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this plan reviewer department applies.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            }
        },
        "UsePlanning":{
            "title":"Planning and Zoning",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the plan reviewer department is applicable to the Planning and Zoning classification.",
            "nullable":true
        },
        "DepartmentLeadId":{
            "title":"Department Lead",
            "type":"integer",
            "description":"The unique identifier for the plan reviewer department lead.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "DepartmentId":{
            "title":"Department ID",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier for a plan reviewer department.",
            "nullable":false
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the plan reviewer department is enabled. If true, the plan reviewer department is enabled and is a valid value that can be selected as a plan reviewer department. If false, the plan reviewer department is not a valid value and can't be selected as a plan reviewer department. The default value is true.",
            "nullable":false
        },
        "UsePermitting":{
            "title":"Permits",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the plan reviewer department is applicable to the Permit classification.",
            "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 : publicSectorPlanReviewerDepartments-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The agency identifier of the public sector entity to which this plan reviewer department applies.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the plan reviewer department.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the plan reviewer department was created.
• Department: string
  Title: Department

  Maximum Length: 25

  The value that will be displayed for a plan reviewer department. This value is user-defined.
• DepartmentId: string
  Title: Department ID

  Maximum Length: 30

  The unique identifier for a plan reviewer department.
• DepartmentLeadId: integer (int64)
  Title: Department Lead

  The unique identifier for the plan reviewer department lead.
• DepartmentLeadName: string
  Title: Department Lead

  Read Only: true

  Maximum Length: 240

  The name of the department lead. Public users see only Staff instead of the name.
• Description: string
  Title: Description

  Maximum Length: 500

  The long description value for a plan reviewer department.
• EnabledFlag: string
  Title: Enabled

  Maximum Length: 1

  Indicates whether the plan reviewer department is enabled. If true, the plan reviewer department is enabled and is a valid value that can be selected as a plan reviewer department. If false, the plan reviewer department is not a valid value and can't be selected as a plan reviewer department. The default value is true.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the plan reviewer department was last modified.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last modified the plan reviewer department.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• UsePermitting: boolean
  Title: Permits

  Maximum Length: 1

  Indicates whether the plan reviewer department is applicable to the Permit classification.
• UsePlanning: boolean
  Title: Planning and Zoning

  Maximum Length: 1

  Indicates whether the plan reviewer department is applicable to the Planning and Zoning classification.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last modified the plan reviewer department.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the plan reviewer department 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 plan reviewer department.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"500",
            "type":"string",
            "description":"The long description value for a plan reviewer department.",
            "nullable":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The agency identifier of the public sector entity to which this plan reviewer department applies.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "DepartmentLeadId":{
            "title":"Department Lead",
            "type":"integer",
            "description":"The unique identifier for the plan reviewer department lead.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Department":{
            "title":"Department",
            "maxLength":"25",
            "type":"string",
            "description":"The value that will be displayed for a plan reviewer department. This value is user-defined.",
            "nullable":false,
            "x-queryable":true
        },
        "UsePlanning":{
            "title":"Planning and Zoning",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the plan reviewer department is applicable to the Planning and Zoning classification.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DepartmentId":{
            "title":"Department ID",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier for a plan reviewer department.",
            "nullable":false,
            "x-queryable":true
        },
        "DepartmentLeadName":{
            "title":"Department Lead",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the department lead. Public users see only Staff instead of the name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the plan reviewer department is enabled. If true, the plan reviewer department is enabled and is a valid value that can be selected as a plan reviewer department. If false, the plan reviewer department is not a valid value and can't be selected as a plan reviewer department. The default value is true.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the plan reviewer department was last modified.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UsePermitting":{
            "title":"Permits",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the plan reviewer department is applicable to the Permit classification.",
            "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