Get a code officer
get
/fscmRestApi/resources/11.13.18.05/publicSectorCodeOfficerLists/{PersonId}
Request
Path Parameters
-
PersonId: integer
The unique identifier of the code enforcement officer.
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : publicSectorCodeOfficerLists-item
Type:
Show Source
object
-
DistrictDescription(optional):
string
Maximum Length:
100
The description of the district ID value. -
DistrictId(optional):
string
Maximum Length:
1000
The unique identifier of the code enforcement district. -
DistrictType(optional):
string
Maximum Length:
1000
The unique identifier of the code enforcement district, based on the functional segregation by agency. -
DistrictTypeDescription(optional):
string
Maximum Length:
100
The description of the district type value. -
InspectionCount(optional):
number
The number of inspections that are scheduled for the code officer on the scheduled date.
-
links(optional):
array Items
Title:
Items
Link Relations -
PersonId(optional):
integer(int64)
The unique identifier of the code enforcement officer.
-
ScheduleDate(optional):
string
Maximum Length:
10
The date for which the availability of the code officer is being determined.
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.