Jump to

• Request
• Response

Get a workflow communication item

get

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

Request

Path Parameters

• LnpRecordKey(required): integer
  The unique identifier for the record.

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(required):
  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(required):
  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 : publicSectorWorkflowCommunications-item-response

Type: object

Show Source

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

  Read Only: true

  The date when the notification about an expiring license or permit is sent.
• AddressKey: integer (int64)
  Read Only: true

  The parcel address key.
• AgencyId: integer (int32)
  Read Only: true

  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.
• AppAcceptDate: string (date-time)
  Title: Acceptance Date

  Read Only: true

  Identifies the accepted date for the permit application.
• ApplAteDate: string (date-time)
  Title: Application About to Expire Date

  Read Only: true

  Identifies the date on which an about-to-expire notification is sent for the permit application.
• ApplExpirationDate: string (date-time)
  Title: Application Expiration Date

  Read Only: true

  The date the application expires.
• Applicant: integer (int64)
  Read Only: true

  The party ID of the permit applicant.
• ApplicantAddress1: string
  Title: Applicant Address Line 1

  Read Only: true

  Maximum Length: 240

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

  Read Only: true

  Maximum Length: 240

  The second line of the permit applicant address.
• ApplicantBizProfileId: integer (int64)
  Read Only: true

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

  Read Only: true

  Maximum Length: 60

  The city in the permit applicant address.
• ApplicantCountry: string
  Title: Applicant Country

  Read Only: true

  Maximum Length: 3

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

  Read Only: true

  Maximum Length: 60

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

  Read Only: true

  Maximum Length: 320

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

  Read Only: true

  Maximum Length: 320

  The second email address of the permit applicant.
• ApplicantPersonName: string
  Title: Applicant Full Name

  Read Only: true

  Maximum Length: 450

  The permit applicant name.
• ApplicantPhoneAreaCode: string
  Read Only: true

  Maximum Length: 10

  The area code in the phone number of the permit applicant.
• ApplicantPhoneCountryCode: string
  Read Only: true

  Maximum Length: 10

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

  Read Only: true

  Maximum Length: 20

  The phone number extension for the permit applicant.
• ApplicantPhoneNumber: string
  Title: Applicant Phone Number

  Read Only: true

  Maximum Length: 80

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

  Read Only: true

  Maximum Length: 60

  The postal code in the permit applicant address.
• ApplicantProfileId: integer (int64)
  Read Only: true

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

  Read Only: true

  Maximum Length: 60

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

  Read Only: true

  Maximum Length: 60

  The state in the permit applicant address.
• ApplicantUserId: string
  Title: Applicant User ID

  Read Only: true

  Maximum Length: 20

  The user ID of the permit applicant.
• BalanceDue: number
  Title: Fees Balance Due

  Read Only: true

  The total fees balance due for the permit application.
• CancelledByName: string
  Title: Canceled by Name

  Read Only: true

  Identifies the user name of the person who canceled the permit application.
• CancelledCreatedBy: string
  Title: Canceled by User ID

  Read Only: true

  Maximum Length: 64

  Identifies the user ID of the person who canceled the permit application.
• CancelledCreationDate: string (date-time)
  Title: Cancellation Date

  Read Only: true

  Identifies the cancelation date of the permit application.
• CancelledReason: string
  Title: Cancellation Reason

  Read Only: true

  Maximum Length: 1000

  Identifies the reason for the cancelation of the permit application.
• Classification: string
  Read Only: true

  Maximum Length: 3

  The record classification. The classifications can be permit, business license, professional license, or planning and zoning.
• ClassificationMeaning: string
  Title: Classification

  Read Only: true

  Maximum Length: 80

  Identifies the classification of the permit application type.
• CreatedBy: string
  Title: Created by User ID

  Read Only: true

  Maximum Length: 64

  Identifies the user ID of the person who created the permit application.
• CreatedByName: string
  Title: Created by Name

  Read Only: true

  Identifies the user name of the person who created the permit application.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Identifies the date on which the permit application was created.
• CurrencyCode: string
  Title: Currency

  Read Only: true

  Maximum Length: 3

  Identifies the currency code.
• DelinquentDate: string (date-time)
  Read Only: true

  The date the license becomes delinquent.
• DistrictName: string
  Read Only: true

  Maximum Length: 50

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

  Read Only: true

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

  Read Only: true

  Identifies the expiration grace date for the permit application.
• ExpirationStatus: string
  Title: Expiration Status

  Read Only: true

  Maximum Length: 15

  Identifies the expiration status of the permit application.
• FeeDueUpdateDate: string (date-time)
  Title: Fees Due Updated Date

  Read Only: true

  Identifier that captures the date when fee item with due status is added or updated.
• GenFloorAreaAddl: number
  Title: Additional Floor Area

  Read Only: true

  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: number
  Title: Existing Floor Area

  Read Only: true

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

  Read Only: true

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

  Read Only: true

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

  Read Only: true

  Maximum Length: 50

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

  Read Only: true

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

  Read Only: true

  Maximum Length: 100

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

  Read Only: true

  Maximum Length: 100

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

  Read Only: true

  Maximum Length: 100

  The type of construction work. Used in the construction information component of the Permit Designer.
• IssueDate: string (date-time)
  Title: Issue Date

  Read Only: true

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

  Read Only: true

  Identifies the last updated date of the permit application.
• LastUpdatedBy: string
  Title: Last Updated by User ID

  Read Only: true

  Maximum Length: 64

  Identifies the user ID of the person who last updated the permit application.
• LastUpdatedByName: string
  Title: Last Updated by Name

  Read Only: true

  Identifies the user name of the person who last updated the permit application.
• Latitude: number
  Read Only: true

  The geographic location of the parcel that is to the North or South of the equator.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LnpRecordId: string
  Title: Permit ID

  Read Only: true

  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: integer
  Read Only: true

  The unique identifier for the record.
• Longitude: number
  Read Only: true

  The geographic location of the parcel that is to the East or West of the meridian. It typically points to a specific entrance area within a large parcel, for example, a security checkpoint gate, delivery entrance, or employee entrance.
• OrganizationName: string
  Title: Business Name

  Read Only: true

  Maximum Length: 360

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

  Read Only: true

  Maximum Length: 3

  Identifies the originator of the permit application.
• Owner: string
  Title: Property Owner Name

  Read Only: true

  Maximum Length: 150

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

  Read Only: true

  Maximum Length: 50

  The parcel owner email address.
• OwnerId: integer (int64)
  Read Only: true

  The owner ID of the record parcel owner.
• OwnerKey: integer (int64)
  Read Only: true

  The owner key of the record parcel owner.
• ParcelAddress1: string
  Title: Property Address Line 1

  Read Only: true

  Maximum Length: 240

  The first line of the parcel or property address.
• ParcelAddress2: string
  Title: Property Address Line 2

  Read Only: true

  Maximum Length: 240

  The second line of the parcel or property address.
• ParcelCity: string
  Title: Property City

  Read Only: true

  Maximum Length: 60

  The city in the parcel or property address.
• ParcelCountry: string
  Title: Property Country

  Read Only: true

  Maximum Length: 60

  The country in the parcel or property address.
• ParcelCounty: string
  Title: Property County

  Read Only: true

  Maximum Length: 60

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

  Read Only: true

  The identifier of the record parcel.
• ParcelKey: integer (int64)
  Read Only: true

  The key of the record parcel.
• ParcelPostalCode: string
  Title: Property Postal Code

  Read Only: true

  Maximum Length: 60

  The postal code in the parcel or property address.
• ParcelProvince: string
  Title: Property Province

  Read Only: true

  Maximum Length: 60

  The province in the parcel or property address.
• ParcelState: string
  Title: Property State

  Read Only: true

  Maximum Length: 60

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

  Read Only: true

  Maximum Length: 30

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

  Read Only: true

  Maximum Length: 300

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

  Read Only: true

  Maximum Length: 100

  The status of the permit record.
• PersonFirstName: string
  Title: Applicant First Name

  Read Only: true

  Maximum Length: 150

  The applicant first name.
• PersonLastName: string
  Title: Applicant Last Name

  Read Only: true

  Maximum Length: 150

  The applicant last name.
• PersonMiddleName: string
  Title: Applicant Middle Name

  Read Only: true

  Maximum Length: 60

  The applicant middle name.
• PersonTitle: string
  Title: Applicant Title

  Read Only: true

  Maximum Length: 60

  The title of the contact.
• Primarycontactemail: string
  Read Only: true

  Maximum Length: 320

  Identifies the email of the primary contact of the permit application.
• Primarycontactname: string
  Read Only: true

  Maximum Length: 450

  Identifies the primary contact name of the permit application.
• Primarycontactpartyid: integer (int64)
  Read Only: true

  Identifies the party ID of the primary contact of the permit application.
• Primarycontactphoneextension: string
  Read Only: true

  Maximum Length: 20

  The contact phone number extension for the primary contact.
• PrimaryContactPhonenumber: string
  Read Only: true

  Maximum Length: 80

  Identifies the phone number of the primary contact of the permit application.
• Primarycontacttype: string
  Read Only: true

  Maximum Length: 30

  Identifies the contact type of the primary contact of the permit application.
• PrimaryContatUserId: string
  Read Only: true

  Identifies the user ID of the primary contact.
• ProjectKey: integer (int64)
  Read Only: true

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

  Read Only: true

  Maximum Length: 240

  The property description.
• ReceivedDate: string (date-time)
  Title: Received Date

  Read Only: true

  Identifies the received date for the permit application.
• RecordStatus: string
  Read Only: true

  Maximum Length: 15

  The status of the record.
• RecordType: string
  Title: Permit Type

  Read Only: true

  Maximum Length: 100

  The permit type. Agencies define the types of permits that they administer, for example, Residential Addition.
• RecordTypeId: string
  Read Only: true

  Maximum Length: 30

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

  Read Only: true

  The renewal date for the license or permit.
• RowType: string
  Read Only: true

  Maximum Length: 30

  The identifier for a record type.
• SecondaryOwner: string
  Title: Property Secondary Owner

  Read Only: true

  Maximum Length: 150

  The secondary owner of the parcel or property.
• Subclassification: string
  Read Only: true

  Maximum Length: 10

  The subclassification code of the permit application type.
• SubclassificationMeaning: string
  Title: Subclassification

  Read Only: true

  Maximum Length: 80

  Identifies the subclassification of the permit application type.
• SubmitDate: string (date-time)
  Title: Submission Date

  Read Only: true

  The date the license and permit transaction was submitted. Used in the application information component of the Permit Designer.
• SubmittedBy: string
  Title: Submitted by User ID

  Read Only: true

  Maximum Length: 64

  Identifies the user ID of the person who submitted the permit application.
• SubmittedByName: string
  Title: Submitted by Name

  Read Only: true

  Identifies the user name of the person who submitted the permit application.
• SystemStatus: string
  Title: Permit System Status

  Read Only: true

  Maximum Length: 15

  Identifies the system status of the permit application.
• TotalFees: number
  Title: Fees Total Amount

  Read Only: true

  The total fees for the permit application.
• TotalHold: number
  Title: Fees on Hold

  Read Only: true

  Identifies the total hold fee amount.
• TotalOutstanding: number
  Title: Fees Outstanding Balance

  Read Only: true

  Identifies the total outstanding fee amount.
• TotalPaid: number
  Title: Fees Total Paid

  Read Only: true

  The total fees paid for the permit application.
• TotalPayable: number
  Title: Fees Total Payable

  Read Only: true

  The total fees payable for the permit application.
• TotalPending: number
  Title: Fees in Pending Status

  Read Only: true

  Identifies the total pending fee amount.
• TotalWaived: number
  Title: Fees Waived

  Read Only: true

  Identifies the total fee waived.
• Url: string
  Title: URL

  Read Only: true

  The URL label for the permit application.
• UrlLabel: string
  Title: Link to Permit Application

  Read Only: true

  The URL for the permit application.
• WithDrawnByName: string
  Title: Withdrawn by Name

  Read Only: true

  Identifies the user name of the person who withdrew the permit application.
• WithdrawnCreatedBy: string
  Title: Withdrawn by User ID

  Read Only: true

  Maximum Length: 64

  Identifies the user ID of the person who withdrew the permit application.
• WithdrawnCreatedDate: string (date-time)
  Title: Withdrawal Date

  Read Only: true

  Identifies the withdrawal date of the permit application.
• WithdrawnReason: string
  Title: Withdrawal Reason

  Read Only: true

  Maximum Length: 1000

  Identifies the reason for the withdrawal of the permit application.

{
    "type":"object",
    "properties":{
        "AboutToExpireDate":{
            "title":"About to Expire Date",
            "type":"string",
            "description":"The date when the notification about an expiring license or permit is sent.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Identifies the date on which the permit application was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantUserId":{
            "title":"Applicant User ID",
            "maxLength":20,
            "type":"string",
            "description":"The user ID of the permit applicant.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "UserID":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "Owner":{
            "title":"Property Owner Name",
            "maxLength":150,
            "type":"string",
            "description":"The primary or only owner of the parcel or property.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AppAcceptDate":{
            "title":"Acceptance Date",
            "type":"string",
            "description":"Identifies the accepted date for the permit application.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubmitDate":{
            "title":"Submission Date",
            "type":"string",
            "description":"The date the license and permit transaction was submitted. Used in the application information component of the Permit Designer.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalHold":{
            "title":"Fees on Hold",
            "type":"number",
            "description":"Identifies the total hold fee amount.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Amount":"Y"
            },
            "x-queryable":true
        },
        "ParcelPostalCode":{
            "title":"Property Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"The postal code in the parcel or property address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonMiddleName":{
            "title":"Applicant Middle Name",
            "maxLength":60,
            "type":"string",
            "description":"The applicant middle name.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":3,
            "type":"string",
            "description":"Identifies the currency code.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "Primarycontactemail":{
            "maxLength":320,
            "type":"string",
            "description":"Identifies the email of the primary contact of the permit application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Email":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "Originator":{
            "title":"Originator",
            "maxLength":3,
            "type":"string",
            "description":"Identifies the originator of the permit application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Classification":{
            "maxLength":3,
            "type":"string",
            "description":"The record classification. The classifications can be permit, business license, professional license, or planning and zoning.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalPaid":{
            "title":"Fees Total Paid",
            "type":"number",
            "description":"The total fees paid for the permit application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Amount":"Y"
            },
            "x-queryable":true
        },
        "UrlLabel":{
            "title":"Link to Permit Application",
            "type":"string",
            "description":"The URL for the permit application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "URLLabel":"Y"
            },
            "x-queryable":true
        },
        "ApplicantProvince":{
            "title":"Applicant Province",
            "maxLength":60,
            "type":"string",
            "description":"The province in the permit applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "SecondaryOwner":{
            "title":"Property Secondary Owner",
            "maxLength":150,
            "type":"string",
            "description":"The secondary owner of the parcel or property.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated by User ID",
            "maxLength":64,
            "type":"string",
            "description":"Identifies the user ID of the person who last updated the permit application.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "UserID":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ParcelProvince":{
            "title":"Property Province",
            "maxLength":60,
            "type":"string",
            "description":"The province in the parcel or property address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantProfileId":{
            "type":"integer",
            "description":"The user profile of the applicant.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created by User ID",
            "maxLength":64,
            "type":"string",
            "description":"Identifies the user ID of the person who created the permit application.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "UserID":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "PersonLastName":{
            "title":"Applicant Last Name",
            "maxLength":150,
            "type":"string",
            "description":"The applicant last name.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ParcelCounty":{
            "title":"Property County",
            "maxLength":60,
            "type":"string",
            "description":"The county in the parcel or property address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubmittedBy":{
            "title":"Submitted by User ID",
            "maxLength":64,
            "type":"string",
            "description":"Identifies the user ID of the person who submitted the permit application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "UserID":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ParcelState":{
            "title":"Property State",
            "maxLength":60,
            "type":"string",
            "description":"The state in the parcel or property address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonFirstName":{
            "title":"Applicant First Name",
            "maxLength":150,
            "type":"string",
            "description":"The applicant first name.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "AddressKey":{
            "type":"integer",
            "description":"The parcel address key.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ApplicantCounty":{
            "title":"Applicant County",
            "maxLength":60,
            "type":"string",
            "description":"The county in the permit applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"The unique identifier for the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "brf:CommOrder":"1"
            },
            "x-queryable":true
        },
        "Longitude":{
            "type":"number",
            "description":"The geographic location of the parcel that is to the East or West of the meridian. It typically points to a specific entrance area within a large parcel, for example, a security checkpoint gate, delivery entrance, or employee entrance.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CancelledReason":{
            "title":"Cancellation Reason",
            "maxLength":1000,
            "type":"string",
            "description":"Identifies the reason for the cancelation of the permit application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ClassificationMeaning":{
            "title":"Classification",
            "maxLength":80,
            "type":"string",
            "description":"Identifies the classification of the permit application type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyDescription":{
            "title":"Property Description",
            "maxLength":240,
            "type":"string",
            "description":"The property description.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "RenewalDate":{
            "title":"Renewal Date",
            "type":"string",
            "description":"The renewal date for the license or permit.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ExpirationGraceDate":{
            "title":"Grace Period Date",
            "type":"string",
            "description":"Identifies the expiration grace date for the permit application.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FeeDueUpdateDate":{
            "title":"Fees Due Updated Date",
            "type":"string",
            "description":"Identifier that captures the date when fee item with due status is added or updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OwnerKey":{
            "type":"integer",
            "description":"The owner key of the record parcel owner.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "Applicant":{
            "type":"integer",
            "description":"The party ID of the permit applicant.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ApplicantPhoneExtension":{
            "title":"Applicant Phone Extension",
            "maxLength":20,
            "type":"string",
            "description":"The phone number extension for the permit applicant.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "GenJobCost":{
            "title":"Job Cost",
            "type":"number",
            "description":"The cost of the construction job. Used in the construction information component of the Permit Designer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "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.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":8,
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ApplicantEmailAddress1":{
            "title":"Applicant Email 1",
            "maxLength":320,
            "type":"string",
            "description":"The first email address of the permit applicant.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Email":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ApplicantEmailAddress2":{
            "title":"Applicant Email 2",
            "maxLength":320,
            "type":"string",
            "description":"The second email address of the permit applicant.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Email":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "GenTypeOfUse":{
            "title":"Type of Use",
            "maxLength":100,
            "type":"string",
            "description":"The intended use of the construction. Used in the construction information component of the Permit Designer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplExpirationDate":{
            "title":"Application Expiration Date",
            "type":"string",
            "description":"The date the application expires.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Url":{
            "title":"URL",
            "type":"string",
            "description":"The URL label for the permit application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "URL":"Y"
            },
            "x-queryable":true
        },
        "OwnerEmailId":{
            "title":"Property Owner Email",
            "maxLength":50,
            "type":"string",
            "description":"The parcel owner email address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Email":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "DelinquentDate":{
            "type":"string",
            "description":"The date the license becomes delinquent.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OwnerId":{
            "type":"integer",
            "description":"The owner ID of the record parcel owner.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "RecordTypeId":{
            "maxLength":30,
            "type":"string",
            "description":"The identifier for a record type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedByName":{
            "title":"Last Updated by Name",
            "type":"string",
            "description":"Identifies the user name of the person who last updated the permit application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordStatus":{
            "maxLength":15,
            "type":"string",
            "description":"The status of the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PermitDescription":{
            "title":"Permit Description",
            "maxLength":300,
            "type":"string",
            "description":"The description of the permit type.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "GenNewFloorAreaClass":{
            "title":"New Floor Area Classification",
            "maxLength":50,
            "type":"string",
            "description":"The classification of the new floor area. Used in the construction information component of the Permit Designer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantPhoneCountryCode":{
            "maxLength":10,
            "type":"string",
            "description":"The country code in the phone number of the permit applicant.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "IssueDate":{
            "title":"Issue Date",
            "type":"string",
            "description":"The date the license or permit was issued. Used in the application information component of the Permit Designer.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Primarycontacttype":{
            "maxLength":30,
            "type":"string",
            "description":"Identifies the contact type of the primary contact of the permit application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantCountry":{
            "title":"Applicant Country",
            "maxLength":3,
            "type":"string",
            "description":"The country in the permit applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ApplAteDate":{
            "title":"Application About to Expire Date",
            "type":"string",
            "description":"Identifies the date on which an about-to-expire notification is sent for the permit application.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpirationStatus":{
            "title":"Expiration Status",
            "maxLength":15,
            "type":"string",
            "description":"Identifies the expiration status of the permit application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantBizProfileId":{
            "type":"integer",
            "description":"The business profile used by the applicant.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DistrictName":{
            "maxLength":50,
            "type":"string",
            "description":"The name of the district in which the property is located.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The date the license or permit is no longer valid.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WithDrawnByName":{
            "title":"Withdrawn by Name",
            "type":"string",
            "description":"Identifies the user name of the person who withdrew the permit application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "PermitStatus":{
            "title":"Permit Status",
            "maxLength":100,
            "type":"string",
            "description":"The status of the permit record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Identifies the last updated date of the permit application.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Subclassification":{
            "maxLength":10,
            "type":"string",
            "description":"The subclassification code of the permit application type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParcelAddress2":{
            "title":"Property Address Line 2",
            "maxLength":240,
            "type":"string",
            "description":"The second line of the parcel or property address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParcelAddress1":{
            "title":"Property Address Line 1",
            "maxLength":240,
            "type":"string",
            "description":"The first line of the parcel or property address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Latitude":{
            "type":"number",
            "description":"The geographic location of the parcel that is to the North or South of the equator.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonTitle":{
            "title":"Applicant Title",
            "maxLength":60,
            "type":"string",
            "description":"The title of the contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "GenTypeConstruction":{
            "title":"Type of Construction",
            "maxLength":100,
            "type":"string",
            "description":"The type of construction. Used in the construction information component of the Permit Designer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantPersonName":{
            "title":"Applicant Full Name",
            "maxLength":450,
            "type":"string",
            "description":"The permit applicant name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ParcelKey":{
            "type":"integer",
            "description":"The key of the record parcel.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ApplicantPhoneAreaCode":{
            "maxLength":10,
            "type":"string",
            "description":"The area code in the phone number of the permit applicant.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ParcelType":{
            "title":"Parcel Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the current parcel.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantAddress2":{
            "title":"Applicant Address Line 2",
            "maxLength":240,
            "type":"string",
            "description":"The second line of the permit applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "SubclassificationMeaning":{
            "title":"Subclassification",
            "maxLength":80,
            "type":"string",
            "description":"Identifies the subclassification of the permit application type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "GenTypeOfWork":{
            "title":"Type of Work",
            "maxLength":100,
            "type":"string",
            "description":"The type of construction work. Used in the construction information component of the Permit Designer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WithdrawnReason":{
            "title":"Withdrawal Reason",
            "maxLength":1000,
            "type":"string",
            "description":"Identifies the reason for the withdrawal of the permit application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ApplicantState":{
            "title":"Applicant State",
            "maxLength":60,
            "type":"string",
            "description":"The state in the permit applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "SubmittedByName":{
            "title":"Submitted by Name",
            "type":"string",
            "description":"Identifies the user name of the person who submitted the permit application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CancelledByName":{
            "title":"Canceled by Name",
            "type":"string",
            "description":"Identifies the user name of the person who canceled the permit application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ParcelCity":{
            "title":"Property City",
            "maxLength":60,
            "type":"string",
            "description":"The city in the parcel or property address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalOutstanding":{
            "title":"Fees Outstanding Balance",
            "type":"number",
            "description":"Identifies the total outstanding fee amount.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Amount":"Y"
            },
            "x-queryable":true
        },
        "WithdrawnCreatedDate":{
            "title":"Withdrawal Date",
            "type":"string",
            "description":"Identifies the withdrawal date of the permit application.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReceivedDate":{
            "title":"Received Date",
            "type":"string",
            "description":"Identifies the received date for the permit application.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryContatUserId":{
            "type":"string",
            "description":"Identifies the user ID of the primary contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Primarycontactpartyid":{
            "type":"integer",
            "description":"Identifies the party ID of the primary contact of the permit application.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Email":"Y",
                "precision":18,
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "OrganizationName":{
            "title":"Business Name",
            "maxLength":360,
            "type":"string",
            "description":"The business name of the applicant. For example, a contractor enters his or her contracting business name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProjectKey":{
            "type":"integer",
            "description":"The project name information for a permit.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedByName":{
            "title":"Created by Name",
            "type":"string",
            "description":"Identifies the user name of the person who created the permit application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GenFloorAreaExist":{
            "title":"Existing Floor Area",
            "type":"number",
            "description":"The area of the existing floor in the building. Used in the construction information component of the Permit Designer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RowType":{
            "maxLength":30,
            "type":"string",
            "description":"The identifier for a record type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalPayable":{
            "title":"Fees Total Payable",
            "type":"number",
            "description":"The total fees payable for the permit application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Amount":"Y"
            },
            "x-queryable":true
        },
        "ApplicantCity":{
            "title":"Applicant City",
            "maxLength":60,
            "type":"string",
            "description":"The city in the permit applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "TotalWaived":{
            "title":"Fees Waived",
            "type":"number",
            "description":"Identifies the total fee waived.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Amount":"Y"
            },
            "x-queryable":true
        },
        "GenFloorAreaTotal":{
            "title":"Total Floor Area",
            "type":"number",
            "description":"The total floor area under construction. Used in the construction information component of the Permit Designer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Primarycontactphoneextension":{
            "maxLength":20,
            "type":"string",
            "description":"The contact phone number extension for the  primary contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordType":{
            "title":"Permit Type",
            "maxLength":100,
            "type":"string",
            "description":"The permit type. Agencies define the types of permits that they administer, for example, Residential Addition.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryContactPhonenumber":{
            "maxLength":80,
            "type":"string",
            "description":"Identifies the phone number of the primary contact of the permit application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Phone":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "Primarycontactname":{
            "maxLength":450,
            "type":"string",
            "description":"Identifies the primary contact name of the permit application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantPostalCode":{
            "title":"Applicant Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"The postal code in the permit applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "ApplicantAddress1":{
            "title":"Applicant Address Line 1",
            "maxLength":240,
            "type":"string",
            "description":"The first line of the permit applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "GenFloorAreaAddl":{
            "title":"Additional Floor Area",
            "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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SystemStatus":{
            "title":"Permit System Status",
            "maxLength":15,
            "type":"string",
            "description":"Identifies the system status of the permit application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordId":{
            "title":"Permit ID",
            "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.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "brf:Condition:ObjectType":"LNP",
                "brf:Condition:ObjectSubType":"NA"
            },
            "x-queryable":true
        },
        "ParcelId":{
            "title":"Parcel",
            "type":"integer",
            "description":"The identifier of the record parcel.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TotalPending":{
            "title":"Fees in Pending Status",
            "type":"number",
            "description":"Identifies the total pending fee amount.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Amount":"Y"
            },
            "x-queryable":true
        },
        "ParcelCountry":{
            "title":"Property Country",
            "maxLength":60,
            "type":"string",
            "description":"The country in the parcel or property address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantPhoneNumber":{
            "title":"Applicant Phone Number",
            "maxLength":80,
            "type":"string",
            "description":"The permit applicant phone number.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Reecipient":"Y",
                "Phone":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "GenTotalNumStories":{
            "title":"Total Number of Stories",
            "type":"number",
            "description":"The total number of stories of the structure under construction. Used in the construction information component of the Permit Designer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CancelledCreationDate":{
            "title":"Cancellation Date",
            "type":"string",
            "description":"Identifies the cancelation date of the permit application.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalFees":{
            "title":"Fees Total Amount",
            "type":"number",
            "description":"The total fees for the permit application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Amount":"Y"
            },
            "x-queryable":true
        },
        "BalanceDue":{
            "title":"Fees Balance Due",
            "type":"number",
            "description":"The total fees balance due for the permit application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Amount":"Y"
            },
            "x-queryable":true
        },
        "WithdrawnCreatedBy":{
            "title":"Withdrawn by User ID",
            "maxLength":64,
            "type":"string",
            "description":"Identifies the user ID of the person who withdrew the permit application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "UserID":"Y",
                "Recipient":"Y",
                "brf:Hide":"true"
            },
            "x-queryable":true
        },
        "CancelledCreatedBy":{
            "title":"Canceled by User ID",
            "maxLength":64,
            "type":"string",
            "description":"Identifies the user ID of the person who canceled the permit application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "UserID":"Y",
                "Recipient":"Y",
                "brf:Hide":"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