Jump to

• Request
• Response

Get all permit expiry communication items

get

/fscmRestApi/resources/11.13.18.05/publicSectorPermitExpiryCommunications

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 permit expiry communication data that matches the specified record key. Finder Variables:
    • LnpRecordKey; integer; The unique identifier for the record key.
• 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 : publicSectorPermitExpiryCommunications

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/publicSectorPermitExpiryCommunications-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 publicSectorPermitExpiryCommunications-item

{
    "items":{
        "$ref":"#/definitions/publicSectorPermitExpiryCommunications-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 : publicSectorPermitExpiryCommunications-item

Type: object

Show Source

• AboutToExpireDate(optional): string(date-time)
  Title: About to Expire Date

  The date when the notification about an expiring license or permit is sent.
• AddressKey(optional): integer(int64)
  The parcel address key.
• AgencyId(optional): integer(int32)
  The identifier for a public sector agency. This is usually an alphanumeric identifier for a city, county, or state, but it can also be the name of a city, county, or state.
• ApplAteDate(optional): string(date-time)
  The date to indicate when the application is about to expire.
• ApplExpirationDate(optional): string(date-time)
  Title: Application Expiration Date

  The date when the application expires.
• Applicant(optional): integer(int64)
  Title: Applicant

  The party identifier of the permit applicant.
• ApplicantAddress1(optional): string
  Title: Applicant Address Line 1

  Maximum Length: 240

  The first line of the permit applicant address.
• ApplicantAddress2(optional): string
  Title: Applicant Address Line 2

  Maximum Length: 240

  The second line of the permit applicant address.
• ApplicantBizProfileId(optional): integer(int64)
  Title: Adult Oriented Business

  The business profile used by the applicant.
• ApplicantCity(optional): string
  Title: Applicant City

  Maximum Length: 60

  The city in the permit applicant address.
• ApplicantCountry(optional): string
  Maximum Length: 3

  The country in the permit applicant address.
• ApplicantCounty(optional): string
  Title: Applicant County

  Maximum Length: 60

  The county in the permit applicant address.
• ApplicantEmailAddress1(optional): string
  Title: Applicant Email 1

  Maximum Length: 320

  The first email address of the permit applicant.
• ApplicantEmailAddress2(optional): string
  Title: Applicant Email 2

  Maximum Length: 320

  The second email address of the permit applicant.
• ApplicantPhoneAreaCode(optional): string
  Title: Applicant Phone Area Code

  Maximum Length: 10

  The area code in the phone number of the permit applicant.
• ApplicantPhoneCountryCode(optional): string
  Title: Applicant Phone Country Code

  Maximum Length: 10

  The country code in the phone number of the permit applicant.
• ApplicantPhoneExtension(optional): string
  Title: Applicant Phone Extension

  Maximum Length: 20

  The phone number extension of the permit applicant.
• ApplicantPhoneNumber(optional): string
  Title: Applicant Phone Number

  Maximum Length: 40

  The permit applicant phone number.
• ApplicantPostalCode(optional): string
  Title: Applicant Postal Code

  Maximum Length: 60

  The postal code in the permit applicant address.
• ApplicantProfileId(optional): integer(int64)
  Title: Applicant Profile

  The user profile of the applicant.
• ApplicantProvince(optional): string
  Title: Applicant Province

  Maximum Length: 60

  The province in the permit applicant address.
• ApplicantState(optional): string
  Title: Applicant State

  Maximum Length: 60

  The state in the permit applicant address.
• BalanceDue(optional): number
  Title: Total Due

  The application balance due amount.
• Classification(optional): string
  Title: Classification

  Maximum Length: 3

  The record classification. The classifications can be permit, business license, professional license, or planning and zoning.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The user who created the record.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The user who last updated the record.
• DelinquentDate(optional): string(date-time)
  Title: Delinquent Date

  The date the license becomes delinquent.
• DistrictName(optional): string
  Title: District

  Maximum Length: 50

  The type of the current parcel.
• ExpirationDate(optional): string(date-time)
  Title: Expiration Date

  The date the license or permit is no longer valid.
• ExpirationGraceDate(optional): string(date-time)
  Title: Grace Period End Date

  The application expiry grace date.
• ExtensionsCount(optional): integer(int32)
  Title: Number of Extensions

  The application expiry extension count.
• GracePeriod(optional): integer(int64)
  Title: Grace Period

  The grace period for the application expiry.
• GracePeriodUom(optional): string
  Title: Grace Period UOM

  Maximum Length: 5

  The grace period unit for the application expiry.
• IssueDate(optional): string(date-time)
  Title: Issue Date

  The date the license or permit was issued. Used in the application information component of the Permit Designer.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date when the record was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The date when the record was created.
• links(optional): array Items
  Title: Items

  Link Relations
• LnpRecordId(optional): string
  Title: Permit ID

  Maximum Length: 50

  The identifier for the building permit record. For example, a permit number with a value such as Building Permit ID RA-2017-00029.
• LnpRecordKey(optional): integer(int64)
  The unique identifier for the record.
• OrganizationName(optional): string
  Title: Organization Name

  Maximum Length: 360

  The business name of the applicant. For example, a contractor enters his or her contracting business name.
• Owner(optional): string
  Title: Owner

  Maximum Length: 150

  The primary or only owner of the parcel or property.
• OwnerEmailId(optional): string
  Title: Owner Email

  Maximum Length: 50

  The parcel owner email address.
• ParcelAddress1(optional): string
  Title: Parcel Address Line 1

  Maximum Length: 240

  The first line of the parcel or property address.
• ParcelAddress2(optional): string
  Title: Parcel Address Line 2

  Maximum Length: 240

  The second line of the parcel or property address.
• ParcelCity(optional): string
  Maximum Length: 60

  The city in the parcel or property address.
• ParcelCountry(optional): string
  Maximum Length: 60

  The country in the parcel or property address.
• ParcelCounty(optional): string
  Maximum Length: 60

  The county in the parcel or property address.
• ParcelId(optional): integer(int64)
  Title: Parcel

  The identifier of the record parcel.
• ParcelPostalCode(optional): string
  Maximum Length: 60

  The postal code in the parcel or property address.
• ParcelProvince(optional): string
  Maximum Length: 60

  The province in the parcel or property address.
• ParcelState(optional): string
  Maximum Length: 60

  The state in the parcel or property address.
• ParcelType(optional): string
  Title: Parcel Type

  Maximum Length: 30

  The key of the record parcel.
• PermitDescription(optional): string
  Title: Permit Description

  Maximum Length: 1000

  The description of the permit type.
• PermitStatus(optional): string
  Title: Permit Status

  Maximum Length: 100

  The status of the permit record.
• PersonName(optional): string
  Title: Applicant Name

  Maximum Length: 450

  The permit applicant name.
• PrimaryContactEmail(optional): string
  Title: Contact Email

  Maximum Length: 320

  The application primary contact email.
• PrimaryContactName(optional): string
  Title: Location Contact

  Maximum Length: 450

  The application primary contact name.
• PrimaryContactPhone(optional): string
  Title: Contact Phone Number

  Maximum Length: 60

  The application primary contact phone.
• ProjectKey(optional): integer(int64)
  Title: Project

  The project name information for a permit.
• PropertyDescription(optional): string
  Title: Property Description

  Maximum Length: 240

  The property description.
• RecordStatus(optional): string
  Maximum Length: 15

  The status of the record.
• RecordType(optional): string
  Title: Record Type

  Maximum Length: 100

  The permit type. Agencies define the types of permits that they administer, for example, Residential Addition.
• RenewalDate(optional): string(date-time)
  Title: Renewal Date

  The renewal date for the license or permit.
• SecondaryOwner(optional): string
  Title: Secondary Owner

  Maximum Length: 150

  The secondary owner of the parcel or property.
• SubmitDate(optional): string(date-time)
  Title: Submission Date

  The date the license and permit transaction was submitted. Used in the application information component of the Permit Designer.
• SubmittedBy(optional): string
  Title: Submitted By

  Maximum Length: 64

  The user who submitted the application.
• Username(optional): string
  Title: Applicant User ID

  Maximum Length: 100

  The user ID of the permit applicant.

{
    "properties":{
        "AboutToExpireDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the notification about an expiring license or permit is sent.",
            "title":"About to Expire Date"
        },
        "AddressKey":{
            "format":"int64",
            "type":"integer",
            "description":"The parcel address key."
        },
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The identifier for a public sector agency. This is usually an alphanumeric identifier for a city, county, or state, but it can also be the name of a city, county, or state."
        },
        "ApplAteDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date to indicate when the application is about to expire."
        },
        "ApplExpirationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the application expires.",
            "title":"Application Expiration Date"
        },
        "Applicant":{
            "format":"int64",
            "type":"integer",
            "description":"The party identifier of the permit applicant.",
            "title":"Applicant"
        },
        "ApplicantAddress1":{
            "maxLength":240,
            "type":"string",
            "description":"The first line of the permit applicant address.",
            "title":"Applicant Address Line 1"
        },
        "ApplicantAddress2":{
            "maxLength":240,
            "type":"string",
            "description":"The second line of the permit applicant address.",
            "title":"Applicant Address Line 2"
        },
        "ApplicantBizProfileId":{
            "format":"int64",
            "type":"integer",
            "description":"The business profile used by the applicant.",
            "title":"Adult Oriented Business"
        },
        "ApplicantCity":{
            "maxLength":60,
            "type":"string",
            "description":"The city in the permit applicant address.",
            "title":"Applicant City"
        },
        "ApplicantCountry":{
            "maxLength":3,
            "type":"string",
            "description":"The country in the permit applicant address."
        },
        "ApplicantCounty":{
            "maxLength":60,
            "type":"string",
            "description":"The county in the permit applicant address.",
            "title":"Applicant County"
        },
        "ApplicantEmailAddress1":{
            "maxLength":320,
            "type":"string",
            "description":"The first email address of the permit applicant.",
            "title":"Applicant Email 1"
        },
        "ApplicantEmailAddress2":{
            "maxLength":320,
            "type":"string",
            "description":"The second email address of the permit applicant.",
            "title":"Applicant Email 2"
        },
        "ApplicantPhoneAreaCode":{
            "maxLength":10,
            "type":"string",
            "description":"The area code in the phone number of the permit applicant.",
            "title":"Applicant Phone Area Code"
        },
        "ApplicantPhoneCountryCode":{
            "maxLength":10,
            "type":"string",
            "description":"The country code in the phone number of the permit applicant.",
            "title":"Applicant Phone Country Code"
        },
        "ApplicantPhoneExtension":{
            "maxLength":20,
            "type":"string",
            "description":"The phone number extension of the permit applicant.",
            "title":"Applicant Phone Extension"
        },
        "ApplicantPhoneNumber":{
            "maxLength":40,
            "type":"string",
            "description":"The permit applicant phone number.",
            "title":"Applicant Phone Number"
        },
        "ApplicantPostalCode":{
            "maxLength":60,
            "type":"string",
            "description":"The postal code in the permit applicant address.",
            "title":"Applicant Postal Code"
        },
        "ApplicantProfileId":{
            "format":"int64",
            "type":"integer",
            "description":"The user profile of the applicant.",
            "title":"Applicant Profile"
        },
        "ApplicantProvince":{
            "maxLength":60,
            "type":"string",
            "description":"The province in the permit applicant address.",
            "title":"Applicant Province"
        },
        "ApplicantState":{
            "maxLength":60,
            "type":"string",
            "description":"The state in the permit applicant address.",
            "title":"Applicant State"
        },
        "BalanceDue":{
            "type":"number",
            "description":"The application balance due amount.",
            "title":"Total Due"
        },
        "Classification":{
            "maxLength":3,
            "type":"string",
            "description":"The record classification. The classifications can be permit, business license, professional license, or planning and zoning.",
            "title":"Classification"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The user who last updated the record.",
            "title":"Creation Date"
        },
        "DelinquentDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date the license becomes delinquent.",
            "title":"Delinquent Date"
        },
        "DistrictName":{
            "maxLength":50,
            "type":"string",
            "description":"The type of the current parcel.",
            "title":"District"
        },
        "ExpirationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date the license or permit is no longer valid.",
            "title":"Expiration Date"
        },
        "ExpirationGraceDate":{
            "format":"date-time",
            "type":"string",
            "description":"The application expiry grace date.",
            "title":"Grace Period End Date"
        },
        "ExtensionsCount":{
            "format":"int32",
            "type":"integer",
            "description":"The application expiry extension count.",
            "title":"Number of Extensions"
        },
        "GracePeriod":{
            "format":"int64",
            "type":"integer",
            "description":"The grace period for the application expiry.",
            "title":"Grace Period"
        },
        "GracePeriodUom":{
            "maxLength":5,
            "type":"string",
            "description":"The grace period unit for the application expiry.",
            "title":"Grace Period UOM"
        },
        "IssueDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date the license or permit was issued. Used in the application information component of the Permit Designer.",
            "title":"Issue Date"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the record was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The date when the record was created.",
            "title":"Last Updated By"
        },
        "LnpRecordId":{
            "maxLength":50,
            "type":"string",
            "description":"The identifier for the building permit record. For example, a permit number with a value such as Building Permit ID RA-2017-00029.",
            "title":"Permit ID"
        },
        "LnpRecordKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the record."
        },
        "OrganizationName":{
            "maxLength":360,
            "type":"string",
            "description":"The business name of the applicant. For example, a contractor enters his or her contracting business name.",
            "title":"Organization Name"
        },
        "Owner":{
            "maxLength":150,
            "type":"string",
            "description":"The primary or only owner of the parcel or property.",
            "title":"Owner"
        },
        "OwnerEmailId":{
            "maxLength":50,
            "type":"string",
            "description":"The parcel owner email address.",
            "title":"Owner Email"
        },
        "ParcelAddress1":{
            "maxLength":240,
            "type":"string",
            "description":"The first line of the parcel or property address.",
            "title":"Parcel Address Line 1"
        },
        "ParcelAddress2":{
            "maxLength":240,
            "type":"string",
            "description":"The second line of the parcel or property address.",
            "title":"Parcel Address Line 2"
        },
        "ParcelCity":{
            "maxLength":60,
            "type":"string",
            "description":"The city in the parcel or property address."
        },
        "ParcelCountry":{
            "maxLength":60,
            "type":"string",
            "description":"The country in the parcel or property address."
        },
        "ParcelCounty":{
            "maxLength":60,
            "type":"string",
            "description":"The county in the parcel or property address."
        },
        "ParcelId":{
            "format":"int64",
            "type":"integer",
            "description":"The identifier of the record parcel.",
            "title":"Parcel"
        },
        "ParcelPostalCode":{
            "maxLength":60,
            "type":"string",
            "description":"The postal code in the parcel or property address."
        },
        "ParcelProvince":{
            "maxLength":60,
            "type":"string",
            "description":"The province in the parcel or property address."
        },
        "ParcelState":{
            "maxLength":60,
            "type":"string",
            "description":"The state in the parcel or property address."
        },
        "ParcelType":{
            "maxLength":30,
            "type":"string",
            "description":"The key of the record parcel.",
            "title":"Parcel Type"
        },
        "PermitDescription":{
            "maxLength":1000,
            "type":"string",
            "description":"The description of the permit type.",
            "title":"Permit Description"
        },
        "PermitStatus":{
            "maxLength":100,
            "type":"string",
            "description":"The status of the permit record.",
            "title":"Permit Status"
        },
        "PersonName":{
            "maxLength":450,
            "type":"string",
            "description":"The permit applicant name.",
            "title":"Applicant Name"
        },
        "PrimaryContactEmail":{
            "maxLength":320,
            "type":"string",
            "description":"The application primary contact email.",
            "title":"Contact Email"
        },
        "PrimaryContactName":{
            "maxLength":450,
            "type":"string",
            "description":"The application primary contact name.",
            "title":"Location Contact"
        },
        "PrimaryContactPhone":{
            "maxLength":60,
            "type":"string",
            "description":"The application primary contact phone.",
            "title":"Contact Phone Number"
        },
        "ProjectKey":{
            "format":"int64",
            "type":"integer",
            "description":"The project name information for a permit.",
            "title":"Project"
        },
        "PropertyDescription":{
            "maxLength":240,
            "type":"string",
            "description":"The property description.",
            "title":"Property Description"
        },
        "RecordStatus":{
            "maxLength":15,
            "type":"string",
            "description":"The status of the record."
        },
        "RecordType":{
            "maxLength":100,
            "type":"string",
            "description":"The permit type. Agencies define the types of permits that they administer, for example, Residential Addition.",
            "title":"Record Type"
        },
        "RenewalDate":{
            "format":"date-time",
            "type":"string",
            "description":"The renewal date for the license or permit.",
            "title":"Renewal Date"
        },
        "SecondaryOwner":{
            "maxLength":150,
            "type":"string",
            "description":"The secondary owner of the parcel or property.",
            "title":"Secondary Owner"
        },
        "SubmitDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date the license and permit transaction was submitted. Used in the application information component of the Permit Designer.",
            "title":"Submission Date"
        },
        "SubmittedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who submitted the application.",
            "title":"Submitted By"
        },
        "Username":{
            "maxLength":100,
            "type":"string",
            "description":"The user ID of the permit applicant.",
            "title":"Applicant User ID"
        },
        "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