Jump to

• Request
• Response

Get all agencies' code enforcement options

get

/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementAgencyOptions

Request

Query Parameters

• dependency: string
  This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the attributes will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency attributes. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• 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 attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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:
  
  

  • 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. Finder Variables:
    • AgencyId; integer; The unique identifier for an agency.
    • OfferingId; string; The unique identifier for an offering.
• 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.
• 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 attributes. 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
• 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".

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourcecollection+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorCodeEnforcementAgencyOptions

Type: object

Show Source

• count(optional): integer
  Title: Count

  The number of resource instances returned in the current range.
• hasMore(optional): boolean
  Title: HasMore

  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(optional): array Items
  Title: Items

  The items in the collection.
• limit(optional): integer
  Title: Limit

  The actual paging size used by the server.
• links(optional): array Items
  Title: Items

  The link relations associated with the resource instance.
• offset(optional): integer
  Title: Offset

  The offset value used in the current page.

{
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range.",
            "title":"Count"
        },
        "hasMore":{
            "type":"boolean",
            "description":"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.",
            "title":"HasMore"
        },
        "items":{
            "items":{
                "$ref":"#/definitions/publicSectorCodeEnforcementAgencyOptions-item"
            },
            "type":"array",
            "description":"The items in the collection.",
            "title":"Items"
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server.",
            "title":"Limit"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "title":"Items"
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page.",
            "title":"Offset"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorCodeEnforcementAgencyOptions-item

{
    "items":{
        "$ref":"#/definitions/publicSectorCodeEnforcementAgencyOptions-item"
    },
    "type":"array",
    "description":"The items in the collection.",
    "title":"Items"
}

Nested Schema : Items

Type: array

Title: Items

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "title":"Items"
}

Nested Schema : publicSectorCodeEnforcementAgencyOptions-item

Type: object

Show Source

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

  Maximum Length: 1

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

  Maximum Length: 1

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

  Maximum Length: 20

  The autonumber rule for citations.
• AutoNumRuleInspection(optional): string
  Title: Inspection Autonumber Rule

  Maximum Length: 20

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

  Maximum Length: 20

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

  Maximum Length: 1

  Indicates whether new code enforcement incidents should be automatically assigned to code enforcement technicians.
• ContentUrl(optional): 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(optional): array Items
  Title: Items

  Link Relations
• LongDescription(optional): string
  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(optional): 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(optional): 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(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
  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(optional): string
  Maximum Length: 50

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

  Maximum Length: 30

  The unique identifier for the agency's work schedule.
• ShortDescription(optional): 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(optional): 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(optional): string
  Title: Enable Workflow

  Maximum Length: 1

  Indicates whether the agency has enabled the workflow.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier for an agency."
        },
        "AnonymousFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether anonymous users are allowed to submit incidents.",
            "title":"Contact Information Required for Issue Reporting"
        },
        "AutoAssignment":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the agency has enabled automatic scheduling and assignment of incident inspections.",
            "title":"Autoassignment"
        },
        "AutoNumRuleCitation":{
            "maxLength":20,
            "type":"string",
            "description":"The autonumber rule for citations.",
            "title":"Citation Autonumber Rule"
        },
        "AutoNumRuleInspection":{
            "maxLength":20,
            "type":"string",
            "description":"The autonumber rule for inspections.",
            "title":"Inspection Autonumber Rule"
        },
        "AutoNumRuleNotice":{
            "maxLength":20,
            "type":"string",
            "description":"The autonumber rule for notices.",
            "title":"Notice Autonumber Rule"
        },
        "AutoRouteInc":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether new code enforcement incidents should be automatically assigned to code enforcement technicians.",
            "title":"Automatically Route Issues"
        },
        "ContentUrl":{
            "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.",
            "title":"Content URL"
        },
        "LongDescription":{
            "type":"string",
            "description":"The long description of the code enforcement offering. This description appears as a message on the code enforcement landing page.",
            "title":"Landing Page Message"
        },
        "MaxInsCount":{
            "format":"int32",
            "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.",
            "title":"Maximum Inspections per Day per Code Officer"
        },
        "MostRecPeriod":{
            "format":"int32",
            "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.",
            "title":"Period"
        },
        "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."
        },
        "MostRecStatus":{
            "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.",
            "title":"Status"
        },
        "OfferingId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the code enforcement offering."
        },
        "ScheduleId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the agency's work schedule.",
            "title":"Agency Work Schedule"
        },
        "ShortDescription":{
            "maxLength":300,
            "type":"string",
            "description":"The short description of the code enforcement offering. This description appears on the code enforcement landing page.",
            "title":"Message Summary"
        },
        "TextLabel":{
            "maxLength":100,
            "type":"string",
            "description":"The label for the code enforcement offering. This appears as the header text on the code enforcement landing page.",
            "title":"Message Title"
        },
        "WorkflowEnabled":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the agency has enabled the workflow.",
            "title":"Enable Workflow"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top