Update an agency's code enforcement options
patch
/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementAgencyOptions/{AgencyId}
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Path Parameters
-
AgencyId: integer
The unique identifier for an agency.
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorCodeEnforcementAgencyOptions-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
The unique identifier for an agency.
-
AnonymousFlag(optional):
string
Maximum Length:
1
Indicates whether anonymous users are allowed to submit incidents. -
AutoAssignment(optional):
string
Maximum Length:
1
s whether the agency has enabled automatic scheduling and assignment of incident inspections -
AutoNumRuleCitation(optional):
string
Maximum Length:
20
The autonumber rule for citations. -
AutoNumRuleInspection(optional):
string
Maximum Length:
20
The autonumber rule for inspections. -
AutoNumRuleNotice(optional):
string
Maximum Length:
20
The autonumber rule for notices. -
ContentUrl(optional):
string
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. -
CreatedBy(optional):
string
Maximum Length:
64
The user who created the agency options. -
CreationDate(optional):
string(date-time)
The date and time that the agency options were created.
-
LastUpdateDate(optional):
string(date-time)
The date and time that the agency options were last updated.
-
LastUpdatedBy(optional):
string
Maximum Length:
64
The user who last updated the agency options. -
LastUpdateLogin(optional):
string
Maximum Length:
32
The session login associated with the user who last updated the agency options. -
links(optional):
array Items
Title:
Items
Link Relations -
LongDescription(optional):
string
The long description of the code enforcement offering. This description appears as a message on the code enforcement landing page.
-
MaxInsCount(optional):
integer(int32)
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(optional):
integer(int32)
The numerical portion of the time period that is used for showing the most recent issues cases on a map. For example, if the time period is 2 months, this attribute is the number 2.
-
MostRecPeriodUnits(optional):
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(optional):
string
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. -
ObjectVersionNumber(optional):
integer(int32)
Used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
-
OfferingId(optional):
string
Maximum Length:
50
The unique identifier for the code enforcement offering. -
ShortDescription(optional):
string
Maximum Length:
300
The short description of the code enforcement offering. This description appears on the code enforcement landing page. -
TextLabel(optional):
string
Maximum Length:
100
The label for the code enforcement offering. This appears as the header text on the code enforcement landing page.
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorCodeEnforcementAgencyOptions-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
The unique identifier for an agency.
-
AnonymousFlag(optional):
string
Maximum Length:
1
Indicates whether anonymous users are allowed to submit incidents. -
AutoAssignment(optional):
string
Maximum Length:
1
s whether the agency has enabled automatic scheduling and assignment of incident inspections -
AutoNumRuleCitation(optional):
string
Maximum Length:
20
The autonumber rule for citations. -
AutoNumRuleInspection(optional):
string
Maximum Length:
20
The autonumber rule for inspections. -
AutoNumRuleNotice(optional):
string
Maximum Length:
20
The autonumber rule for notices. -
ContentUrl(optional):
string
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. -
CreatedBy(optional):
string
Maximum Length:
64
The user who created the agency options. -
CreationDate(optional):
string(date-time)
The date and time that the agency options were created.
-
LastUpdateDate(optional):
string(date-time)
The date and time that the agency options were last updated.
-
LastUpdatedBy(optional):
string
Maximum Length:
64
The user who last updated the agency options. -
LastUpdateLogin(optional):
string
Maximum Length:
32
The session login associated with the user who last updated the agency options. -
links(optional):
array Items
Title:
Items
Link Relations -
LongDescription(optional):
string
The long description of the code enforcement offering. This description appears as a message on the code enforcement landing page.
-
MaxInsCount(optional):
integer(int32)
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(optional):
integer(int32)
The numerical portion of the time period that is used for showing the most recent issues cases on a map. For example, if the time period is 2 months, this attribute is the number 2.
-
MostRecPeriodUnits(optional):
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(optional):
string
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. -
ObjectVersionNumber(optional):
integer(int32)
Used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
-
OfferingId(optional):
string
Maximum Length:
50
The unique identifier for the code enforcement offering. -
ShortDescription(optional):
string
Maximum Length:
300
The short description of the code enforcement offering. This description appears on the code enforcement landing page. -
TextLabel(optional):
string
Maximum Length:
100
The label for the code enforcement offering. This appears as the header text on the code enforcement landing page.
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.