Get all agencies' code enforcement options
get
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementAgencyOptions
Request
Query Parameters
-
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- OfferingId: Finds the offering that matches the primary key criteria specified.
Finder Variables:- AgencyId; integer; The unique identifier for an agency.
- OfferingId; string; The unique identifier for an offering.
- PrimaryKey: Finds the agency that matches the primary key criteria specified.
Finder Variables:- AgencyId; integer; The unique identifier for an agency.
- OfferingId: Finds the offering that matches the primary key criteria specified.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- AgencyId; integer; The unique identifier for an agency.
- AnonymousFlag; string; Indicates whether anonymous users are allowed to submit incidents.
- AutoAssignment; string; Indicates whether the agency has enabled automatic scheduling and assignment of incident inspections.
- AutoNumRuleCitation; string; The autonumber rule for citations.
- AutoNumRuleFee; string; The autonumber rule for the fee reference identifier.
- AutoNumRuleInspection; string; The autonumber rule for inspections.
- AutoNumRuleNotice; string; The autonumber rule for notices.
- AutoRouteInc; string; Indicates whether new code enforcement incidents should be automatically assigned to code enforcement technicians.
- ContentUrl; string; 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.
- MaxInsCount; integer; 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; 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; 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; 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; The unique identifier for the code enforcement offering.
- ScheduleId; string; The unique identifier for the agency's work schedule.
- ShortDescription; string; The short description of the code enforcement offering. This description appears on the code enforcement landing page.
- TextLabel; string; The label for the code enforcement offering. This appears as the header text on the code enforcement landing page.
- WorkflowEnabled; string; Indicates whether the agency has enabled the workflow.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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.
There's no request body for this operation.
Back to TopResponse
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.
Root Schema : publicSectorCodeEnforcementAgencyOptions
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested 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.