Jump to

• Request
• Response

Create a set of agency code enforcement options

post

/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementAgencyOptions

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)
  The unique identifier for an agency.
• AnonymousFlag: string
  Title: Contact Information Required for Issue Reporting

  Maximum Length: 1

  Indicates whether anonymous users are allowed to submit incidents.
• AutoAssignment: string
  Title: Autoassignment

  Maximum Length: 1

  Indicates whether the agency has enabled automatic scheduling and assignment of incident inspections.
• AutoNumRuleCitation: string
  Title: Citation Autonumber Rule

  Maximum Length: 20

  The autonumber rule for citations.
• AutoNumRuleFee: string
  Title: Fee Autonumber Rule

  Maximum Length: 20

  The autonumber rule for the fee reference identifier.
• AutoNumRuleInspection: string
  Title: Inspection Autonumber Rule

  Maximum Length: 20

  The autonumber rule for inspections.
• AutoNumRuleNotice: string
  Title: Notice Autonumber Rule

  Maximum Length: 20

  The autonumber rule for notices.
• AutoRouteInc: string
  Title: Automatically Route Issues

  Maximum Length: 1

  Indicates whether new code enforcement incidents should be automatically assigned to code enforcement technicians.
• ContentUrl: string
  Title: Content URL

  Maximum Length: 250

  The URL for a page with additional code enforcement information for public users. This URL appears on the code enforcement landing page for public users.
• LongDescription: string (byte)
  Title: Landing Page Message

  The long description of the code enforcement offering. This description appears as a message on the code enforcement landing page.
• MaxInsCount: integer (int32)
  Title: Maximum Inspections per Day per Code Officer

  The maximum number of inspections per day for code officers. The autoassignment process will not assign inspections to officers who are at the maximum, but users can manually exceed this maximum.
• MostRecPeriod: integer (int32)
  Title: Period

  The numerical portion of the time period that is used for showing the most recent issues or cases on a map. For example, if the time period is 2 months, this attribute is the number 2.
• MostRecPeriodUnits: string
  Maximum Length: 30

  The type of time period that is used for showing the most recent issues on a map. For example, if the time period is 2 months, this attribute is Months. Valid values are Days, Weeks, or Months.
• MostRecStatus: string
  Title: Status

  Maximum Length: 15

  Indicates which issues appear on the map of recent issues. If the value is All, then issues appear on the map regardless of their status. If the value is Active, then only active issues appear on the map.
• OfferingId: string
  Maximum Length: 50

  The unique identifier for the code enforcement offering.
• ScheduleId: string
  Title: Agency Work Schedule

  Maximum Length: 30

  The unique identifier for the agency's work schedule.
• ShortDescription: string
  Title: Message Summary

  Maximum Length: 300

  The short description of the code enforcement offering. This description appears on the code enforcement landing page.
• TextLabel: string
  Title: Message Title

  Maximum Length: 100

  The label for the code enforcement offering. This appears as the header text on the code enforcement landing page.
• WorkflowEnabled: string
  Title: Enable Workflow

  Maximum Length: 1

  Default Value: N

  Indicates whether the agency has enabled the workflow.

{
    "type":"object",
    "properties":{
        "ContentUrl":{
            "title":"Content URL",
            "maxLength":"250",
            "type":"string",
            "description":"The URL for a page with additional code enforcement information for public users. This URL appears on the code enforcement landing page for public users.",
            "nullable":true
        },
        "AnonymousFlag":{
            "title":"Contact Information Required for Issue Reporting",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether anonymous users are allowed to submit incidents.",
            "nullable":false
        },
        "TextLabel":{
            "title":"Message Title",
            "maxLength":"100",
            "type":"string",
            "description":"The label for the code enforcement offering. This appears as the header text on the code enforcement landing page.",
            "nullable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier for an agency.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"8"
            }
        },
        "AutoRouteInc":{
            "title":"Automatically Route Issues",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether new code enforcement incidents should be automatically assigned to code enforcement technicians.",
            "nullable":false
        },
        "AutoNumRuleNotice":{
            "title":"Notice Autonumber Rule",
            "maxLength":"20",
            "type":"string",
            "description":"The autonumber rule for notices.",
            "nullable":true
        },
        "MostRecPeriod":{
            "title":"Period",
            "type":"integer",
            "description":"The numerical portion of the time period that is used for showing the most recent issues or cases on a map. For example, if the time period is 2 months, this attribute is the number 2.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"5"
            }
        },
        "MostRecPeriodUnits":{
            "maxLength":"30",
            "type":"string",
            "description":"The type of time period that is used for showing the most recent issues on a map. For example, if the time period is 2 months, this attribute is Months. Valid values are Days, Weeks, or Months.",
            "nullable":true
        },
        "AutoAssignment":{
            "title":"Autoassignment",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the agency has enabled automatic scheduling and assignment of incident inspections.",
            "nullable":false
        },
        "ScheduleId":{
            "title":"Agency Work Schedule",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier for the agency's work schedule.",
            "nullable":true
        },
        "WorkflowEnabled":{
            "title":"Enable Workflow",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the agency has enabled the workflow.",
            "nullable":false,
            "default":"N"
        },
        "MostRecStatus":{
            "title":"Status",
            "maxLength":"15",
            "type":"string",
            "description":"Indicates which issues appear on the map of recent issues. If the value is All, then issues appear on the map regardless of their status. If the value is Active, then only active issues appear on the map.",
            "nullable":true
        },
        "ShortDescription":{
            "title":"Message Summary",
            "maxLength":"300",
            "type":"string",
            "description":"The short description of the code enforcement offering. This description appears on the code enforcement landing page.",
            "nullable":true
        },
        "LongDescription":{
            "title":"Landing Page Message",
            "type":"string",
            "description":"The long description of the code enforcement offering. This description appears as a message on the code enforcement landing page.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "MaxInsCount":{
            "title":"Maximum Inspections per Day per Code Officer",
            "type":"integer",
            "description":"The maximum number of inspections per day for code officers. The autoassignment process will not assign inspections to officers who are at the maximum, but users can manually exceed this maximum.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"3"
            }
        },
        "AutoNumRuleCitation":{
            "title":"Citation Autonumber Rule",
            "maxLength":"20",
            "type":"string",
            "description":"The autonumber rule for citations.",
            "nullable":true
        },
        "AutoNumRuleInspection":{
            "title":"Inspection Autonumber Rule",
            "maxLength":"20",
            "type":"string",
            "description":"The autonumber rule for inspections.",
            "nullable":true
        },
        "AutoNumRuleFee":{
            "title":"Fee Autonumber Rule",
            "maxLength":"20",
            "type":"string",
            "description":"The autonumber rule for the fee reference identifier.",
            "nullable":true
        },
        "OfferingId":{
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier for the code enforcement offering.",
            "nullable":false
        }
    }
}

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

Type: object

Show Source

• AgencyId: integer (int32)
  The unique identifier for an agency.
• AnonymousFlag: string
  Title: Contact Information Required for Issue Reporting

  Maximum Length: 1

  Indicates whether anonymous users are allowed to submit incidents.
• AutoAssignment: string
  Title: Autoassignment

  Maximum Length: 1

  Indicates whether the agency has enabled automatic scheduling and assignment of incident inspections.
• AutoNumRuleCitation: string
  Title: Citation Autonumber Rule

  Maximum Length: 20

  The autonumber rule for citations.
• AutoNumRuleFee: string
  Title: Fee Autonumber Rule

  Maximum Length: 20

  The autonumber rule for the fee reference identifier.
• AutoNumRuleInspection: string
  Title: Inspection Autonumber Rule

  Maximum Length: 20

  The autonumber rule for inspections.
• AutoNumRuleNotice: string
  Title: Notice Autonumber Rule

  Maximum Length: 20

  The autonumber rule for notices.
• AutoRouteInc: string
  Title: Automatically Route Issues

  Maximum Length: 1

  Indicates whether new code enforcement incidents should be automatically assigned to code enforcement technicians.
• ContentUrl: string
  Title: Content URL

  Maximum Length: 250

  The URL for a page with additional code enforcement information for public users. This URL appears on the code enforcement landing page for public users.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LongDescription: string (byte)
  Title: Landing Page Message

  The long description of the code enforcement offering. This description appears as a message on the code enforcement landing page.
• MaxInsCount: integer (int32)
  Title: Maximum Inspections per Day per Code Officer

  The maximum number of inspections per day for code officers. The autoassignment process will not assign inspections to officers who are at the maximum, but users can manually exceed this maximum.
• MostRecPeriod: integer (int32)
  Title: Period

  The numerical portion of the time period that is used for showing the most recent issues or cases on a map. For example, if the time period is 2 months, this attribute is the number 2.
• MostRecPeriodUnits: string
  Maximum Length: 30

  The type of time period that is used for showing the most recent issues on a map. For example, if the time period is 2 months, this attribute is Months. Valid values are Days, Weeks, or Months.
• MostRecStatus: string
  Title: Status

  Maximum Length: 15

  Indicates which issues appear on the map of recent issues. If the value is All, then issues appear on the map regardless of their status. If the value is Active, then only active issues appear on the map.
• OfferingId: string
  Maximum Length: 50

  The unique identifier for the code enforcement offering.
• ScheduleId: string
  Title: Agency Work Schedule

  Maximum Length: 30

  The unique identifier for the agency's work schedule.
• ShortDescription: string
  Title: Message Summary

  Maximum Length: 300

  The short description of the code enforcement offering. This description appears on the code enforcement landing page.
• TextLabel: string
  Title: Message Title

  Maximum Length: 100

  The label for the code enforcement offering. This appears as the header text on the code enforcement landing page.
• WorkflowEnabled: string
  Title: Enable Workflow

  Maximum Length: 1

  Default Value: N

  Indicates whether the agency has enabled the workflow.

{
    "type":"object",
    "properties":{
        "ContentUrl":{
            "title":"Content URL",
            "maxLength":"250",
            "type":"string",
            "description":"The URL for a page with additional code enforcement information for public users. This URL appears on the code enforcement landing page for public users.",
            "nullable":true,
            "x-queryable":true
        },
        "AnonymousFlag":{
            "title":"Contact Information Required for Issue Reporting",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether anonymous users are allowed to submit incidents.",
            "nullable":false,
            "x-queryable":true
        },
        "TextLabel":{
            "title":"Message Title",
            "maxLength":"100",
            "type":"string",
            "description":"The label for the code enforcement offering. This appears as the header text on the code enforcement landing page.",
            "nullable":true,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier for an agency.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "AutoRouteInc":{
            "title":"Automatically Route Issues",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether new code enforcement incidents should be automatically assigned to code enforcement technicians.",
            "nullable":false,
            "x-queryable":true
        },
        "AutoNumRuleNotice":{
            "title":"Notice Autonumber Rule",
            "maxLength":"20",
            "type":"string",
            "description":"The autonumber rule for notices.",
            "nullable":true,
            "x-queryable":true
        },
        "MostRecPeriod":{
            "title":"Period",
            "type":"integer",
            "description":"The numerical portion of the time period that is used for showing the most recent issues or cases on a map. For example, if the time period is 2 months, this attribute is the number 2.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"5"
            },
            "x-queryable":true
        },
        "MostRecPeriodUnits":{
            "maxLength":"30",
            "type":"string",
            "description":"The type of time period that is used for showing the most recent issues on a map. For example, if the time period is 2 months, this attribute is Months. Valid values are Days, Weeks, or Months.",
            "nullable":true,
            "x-queryable":true
        },
        "AutoAssignment":{
            "title":"Autoassignment",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the agency has enabled automatic scheduling and assignment of incident inspections.",
            "nullable":false,
            "x-queryable":true
        },
        "ScheduleId":{
            "title":"Agency Work Schedule",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier for the agency's work schedule.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkflowEnabled":{
            "title":"Enable Workflow",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the agency has enabled the workflow.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "MostRecStatus":{
            "title":"Status",
            "maxLength":"15",
            "type":"string",
            "description":"Indicates which issues appear on the map of recent issues. If the value is All, then issues appear on the map regardless of their status. If the value is Active, then only active issues appear on the map.",
            "nullable":true,
            "x-queryable":true
        },
        "ShortDescription":{
            "title":"Message Summary",
            "maxLength":"300",
            "type":"string",
            "description":"The short description of the code enforcement offering. This description appears on the code enforcement landing page.",
            "nullable":true,
            "x-queryable":true
        },
        "LongDescription":{
            "title":"Landing Page Message",
            "type":"string",
            "description":"The long description of the code enforcement offering. This description appears as a message on the code enforcement landing page.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "MaxInsCount":{
            "title":"Maximum Inspections per Day per Code Officer",
            "type":"integer",
            "description":"The maximum number of inspections per day for code officers. The autoassignment process will not assign inspections to officers who are at the maximum, but users can manually exceed this maximum.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"3"
            },
            "x-queryable":true
        },
        "AutoNumRuleCitation":{
            "title":"Citation Autonumber Rule",
            "maxLength":"20",
            "type":"string",
            "description":"The autonumber rule for citations.",
            "nullable":true,
            "x-queryable":true
        },
        "AutoNumRuleInspection":{
            "title":"Inspection Autonumber Rule",
            "maxLength":"20",
            "type":"string",
            "description":"The autonumber rule for inspections.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AutoNumRuleFee":{
            "title":"Fee Autonumber Rule",
            "maxLength":"20",
            "type":"string",
            "description":"The autonumber rule for the fee reference identifier.",
            "nullable":true,
            "x-queryable":true
        },
        "OfferingId":{
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier for the code enforcement offering.",
            "nullable":false,
            "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