Update an agency's code enforcement options
patch
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementAgencyOptions/{AgencyId}
Request
Path Parameters
-
AgencyId(required): integer(int32)
The unique identifier for an agency.
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
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. -
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.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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.
Root Schema : publicSectorCodeEnforcementAgencyOptions-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.