Jump to

• Request
• Response

Get a code enforcement status

get

/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementStatuses/{publicSectorCodeEnforcementStatusesUniqID}

Request

Path Parameters

• publicSectorCodeEnforcementStatusesUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- AgencyId, Classification and Status ---for the Code Enforcement Statuses resource and used to uniquely identify an instance of Code Enforcement Statuses. The client should not generate the hash key value. Instead, the client should query on the Code Enforcement Statuses collection resource with a filter on the primary key values in order to navigate to a specific instance of Code Enforcement Statuses.
  
  For example: publicSectorCodeEnforcementStatuses?q=AgencyId=<value1>;Classification=<value2>;Status=<value3>

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields 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 fields 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 fields. 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 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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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 Top

Response

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.

Body ()

Root Schema : publicSectorCodeEnforcementStatuses-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  The unique identifier for an agency.
• Classification: string
  Maximum Length: 15

  The unique identifier of the code enforcement object classification that indicates if an object is a case, incident, or inspection.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the code enforcement status.
• CreationDate: string (date-time)
  Read Only: true

  The date and time that the code enforcement status was created.
• DeletedFlag: string
  Maximum Length: 1

  Indicates whether the record is deleted.
• EnabledFlag: string
  Title: Enabled

  Maximum Length: 1

  Indicates whether the record is enabled.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time that the code enforcement status was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the code enforcement status.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The session login associated with the user who last updated the code enforcement status.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: 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.
• SeedDataLock: integer (int32)
  Default Value: 0

  Indicates whether the row is seed data. Valid values are 0 for data that is customer data, 1 for seed data that cannot be modified, and 2 for seed data that can be modified.
• Status: string
  Title: Status

  Maximum Length: 15

  The unique identifier of the code enforcement status code.
• StatusName: string
  Title: Description

  Maximum Length: 30

  The description of the code enforcement status code.
• SystemStatus: string
  Title: System Status

  Maximum Length: 15

  The delivered value of a code enforcement status.
• SystemUse: string
  Maximum Length: 1

  Indicates whether workflow integration is active. When workflow integration is active, the workflow system makes all status changes, and users are not permitted to manually update the status.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the code enforcement status.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":"15",
            "type":"string",
            "description":"The unique identifier of the code enforcement status code.",
            "nullable":false,
            "x-queryable":true
        },
        "SystemStatus":{
            "title":"System Status",
            "maxLength":"15",
            "type":"string",
            "description":"The delivered value of a code enforcement status.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time that the code enforcement status was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the code enforcement status.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier for an agency.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"Indicates whether the row is seed data. Valid values are 0 for data that is customer data, 1 for seed data that cannot be modified,  and 2 for seed data that can be modified.",
            "format":"int32",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"1"
            },
            "x-queryable":true
        },
        "SystemUse":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether workflow integration is active. When workflow integration is active, the workflow system makes all status changes, and users are not permitted to manually update the status.",
            "nullable":false,
            "x-queryable":true
        },
        "StatusName":{
            "title":"Description",
            "maxLength":"30",
            "type":"string",
            "description":"The description of the code enforcement status code.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "Classification":{
            "maxLength":"15",
            "type":"string",
            "description":"The unique identifier of the code enforcement object classification that indicates if an object is a case, incident, or inspection.",
            "nullable":false,
            "x-queryable":true
        },
        "DeletedFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the record is deleted.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the record is enabled.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time that the code enforcement status was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The session login associated with the user who last updated the code enforcement status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : link

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top