Jump to

• Request
• Response

Get a workflow communication item

get

/fscmRestApi/resources/11.13.18.05/publicSectorWorkflowCommunications/{LnpRecordKey}

Request

Path Parameters

• LnpRecordKey: integer
  The unique identifier for the record.

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

Back to Top

Response

Supported Media Types

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

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorWorkflowCommunications-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.
• ApplExpirationDate(optional): string(date-time)
  Title: Application Expiration Date

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

  The party ID 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: Business Profile

  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
  Title: Applicant Country

  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.
• ApplicantPersonName(optional): string
  Title: Applicant Name

  Maximum Length: 450

  The permit applicant name.
• 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 for 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.
• ApplicantUserId(optional): string
  Title: Applicant User ID

  Maximum Length: 20

  The user ID of the permit applicant.
• Classification(optional): string
  Title: Classification

  Maximum Length: 3

  The record classification. The classifications can be permit, business license, professional license, or planning and zoning.
• DelinquentDate(optional): string(date-time)
  Title: Delinquent Date

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

  Maximum Length: 50

  The name of the district in which the property is located.
• ExpirationDate(optional): string(date-time)
  Title: Expiration Date

  The date the license or permit is no longer valid.
• GenFloorAreaAddl(optional): number
  Title: Additional Floor Area

  The additional floor area for construction. The floor area refers to the square footage of the construction area. Used in the construction information component of the Permit Designer.
• GenFloorAreaExist(optional): number
  Title: Existing Floor Area

  The area of the existing floor in the building. Used in the construction information component of the Permit Designer.
• GenFloorAreaTotal(optional): number
  Title: Total Floor Area

  The total floor area under construction. Used in the construction information component of the Permit Designer.
• GenJobCost(optional): number
  Title: Job Cost

  The cost of the construction job. Used in the construction information component of the Permit Designer.
• GenNewFloorAreaClass(optional): string
  Title: New Floor Area Classification

  Maximum Length: 50

  The classification of the new floor area. Used in the construction information component of the Permit Designer.
• GenTotalNumStories(optional): number
  Title: Total Number of Stories

  The total number of stories of the structure under construction. Used in the construction information component of the Permit Designer.
• GenTypeConstruction(optional): string
  Title: Type of Construction

  Maximum Length: 100

  The type of construction. Used in the construction information component of the Permit Designer.
• GenTypeOfUse(optional): string
  Title: Type of Use

  Maximum Length: 100

  The intended use of the construction. Used in the construction information component of the Permit Designer.
• GenTypeOfWork(optional): string
  Title: Type of Work

  Maximum Length: 100

  The type of construction work. Used in the construction information component of the Permit Designer.
• 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.
• 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: Business 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.
• OwnerId(optional): integer(int64)
  Title: Owner

  The owner ID of the record parcel owner.
• OwnerKey(optional): integer(int64)
  The owner key of the record parcel owner.
• 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
  Title: Parcel City

  Maximum Length: 60

  The city in the parcel or property address.
• ParcelCountry(optional): string
  Title: Parcel Country

  Maximum Length: 60

  The country in the parcel or property address.
• ParcelCounty(optional): string
  Title: Parcel County

  Maximum Length: 60

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

  The identifier of the record parcel.
• ParcelKey(optional): integer(int64)
  The key of the record parcel.
• ParcelPostalCode(optional): string
  Title: Parcel Postal Code

  Maximum Length: 60

  The postal code in the parcel or property address.
• ParcelProvince(optional): string
  Title: Parcel Province

  Maximum Length: 60

  The province in the parcel or property address.
• ParcelState(optional): string
  Title: Parcel State

  Maximum Length: 60

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

  Maximum Length: 30

  The type of the current parcel.
• PermitDescription(optional): string
  Title: Permit Description

  Maximum Length: 300

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

  Maximum Length: 100

  The status of the permit record.
• PersonFirstName(optional): string
  Maximum Length: 150

  The applicant first name.
• PersonLastName(optional): string
  Maximum Length: 150

  The applicant last name.
• PersonMiddleName(optional): string
  Maximum Length: 60

  The applicant middle name.
• PersonTitle(optional): string
  Maximum Length: 60

  The title of the contact.
• 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: Permit Type

  Maximum Length: 100

  The permit type. Agencies define the types of permits that they administer, for example, Residential Addition.
• RecordTypeId(optional): string
  Maximum Length: 30

  The identifier for a record type.
• RenewalDate(optional): string(date-time)
  Title: Renewal Date

  The renewal date for the license or permit.
• RowType(optional): string
  Maximum Length: 30

  The identifier for a record type.
• 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.

{
    "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."
        },
        "ApplExpirationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date the application expires.",
            "title":"Application Expiration Date"
        },
        "Applicant":{
            "format":"int64",
            "type":"integer",
            "description":"The party ID 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":"Business Profile"
        },
        "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.",
            "title":"Applicant Country"
        },
        "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"
        },
        "ApplicantPersonName":{
            "maxLength":450,
            "type":"string",
            "description":"The permit applicant name.",
            "title":"Applicant Name"
        },
        "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 for 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"
        },
        "ApplicantUserId":{
            "maxLength":20,
            "type":"string",
            "description":"The user ID of the permit applicant.",
            "title":"Applicant User ID"
        },
        "Classification":{
            "maxLength":3,
            "type":"string",
            "description":"The record classification. The classifications can be permit, business license, professional license, or planning and zoning.",
            "title":"Classification"
        },
        "DelinquentDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date the license becomes delinquent.",
            "title":"Delinquent Date"
        },
        "DistrictName":{
            "maxLength":50,
            "type":"string",
            "description":"The name of the district in which the property is located.",
            "title":"District"
        },
        "ExpirationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date the license or permit is no longer valid.",
            "title":"Expiration Date"
        },
        "GenFloorAreaAddl":{
            "type":"number",
            "description":"The additional floor area for construction. The floor area refers to the square footage of the construction area. Used in the construction information component of the Permit Designer.",
            "title":"Additional Floor Area"
        },
        "GenFloorAreaExist":{
            "type":"number",
            "description":"The area of the existing floor in the building. Used in the construction information component of the Permit Designer.",
            "title":"Existing Floor Area"
        },
        "GenFloorAreaTotal":{
            "type":"number",
            "description":"The total floor area under construction. Used in the construction information component of the Permit Designer.",
            "title":"Total Floor Area"
        },
        "GenJobCost":{
            "type":"number",
            "description":"The cost of the construction job. Used in the construction information component of the Permit Designer.",
            "title":"Job Cost"
        },
        "GenNewFloorAreaClass":{
            "maxLength":50,
            "type":"string",
            "description":"The classification of the new floor area. Used in the construction information component of the Permit Designer.",
            "title":"New Floor Area Classification"
        },
        "GenTotalNumStories":{
            "type":"number",
            "description":"The total number of stories of the structure under construction. Used in the construction information component of the Permit Designer.",
            "title":"Total Number of Stories"
        },
        "GenTypeConstruction":{
            "maxLength":100,
            "type":"string",
            "description":"The type of construction. Used in the construction information component of the Permit Designer.",
            "title":"Type of Construction"
        },
        "GenTypeOfUse":{
            "maxLength":100,
            "type":"string",
            "description":"The intended use of the construction. Used in the construction information component of the Permit Designer.",
            "title":"Type of Use"
        },
        "GenTypeOfWork":{
            "maxLength":100,
            "type":"string",
            "description":"The type of construction work. Used in the construction information component of the Permit Designer.",
            "title":"Type of Work"
        },
        "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"
        },
        "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":"Business 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"
        },
        "OwnerId":{
            "format":"int64",
            "type":"integer",
            "description":"The owner ID of the record parcel owner.",
            "title":"Owner"
        },
        "OwnerKey":{
            "format":"int64",
            "type":"integer",
            "description":"The owner key of the record parcel owner."
        },
        "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.",
            "title":"Parcel City"
        },
        "ParcelCountry":{
            "maxLength":60,
            "type":"string",
            "description":"The country in the parcel or property address.",
            "title":"Parcel Country"
        },
        "ParcelCounty":{
            "maxLength":60,
            "type":"string",
            "description":"The county in the parcel or property address.",
            "title":"Parcel County"
        },
        "ParcelId":{
            "format":"int64",
            "type":"integer",
            "description":"The identifier of the record parcel.",
            "title":"Parcel"
        },
        "ParcelKey":{
            "format":"int64",
            "type":"integer",
            "description":"The key of the record parcel."
        },
        "ParcelPostalCode":{
            "maxLength":60,
            "type":"string",
            "description":"The postal code in the parcel or property address.",
            "title":"Parcel Postal Code"
        },
        "ParcelProvince":{
            "maxLength":60,
            "type":"string",
            "description":"The province in the parcel or property address.",
            "title":"Parcel Province"
        },
        "ParcelState":{
            "maxLength":60,
            "type":"string",
            "description":"The state in the parcel or property address.",
            "title":"Parcel State"
        },
        "ParcelType":{
            "maxLength":30,
            "type":"string",
            "description":"The type of the current parcel.",
            "title":"Parcel Type"
        },
        "PermitDescription":{
            "maxLength":300,
            "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"
        },
        "PersonFirstName":{
            "maxLength":150,
            "type":"string",
            "description":"The applicant first name."
        },
        "PersonLastName":{
            "maxLength":150,
            "type":"string",
            "description":"The applicant last name."
        },
        "PersonMiddleName":{
            "maxLength":60,
            "type":"string",
            "description":"The applicant middle name."
        },
        "PersonTitle":{
            "maxLength":60,
            "type":"string",
            "description":"The title of the contact."
        },
        "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":"Permit Type"
        },
        "RecordTypeId":{
            "maxLength":30,
            "type":"string",
            "description":"The identifier for a record type."
        },
        "RenewalDate":{
            "format":"date-time",
            "type":"string",
            "description":"The renewal date for the license or permit.",
            "title":"Renewal Date"
        },
        "RowType":{
            "maxLength":30,
            "type":"string",
            "description":"The identifier for a record type."
        },
        "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"
        },
        "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