Jump to

• Request
• Response

Get all fee records for a fee communication event

get

/fscmRestApi/resources/11.13.18.05/publicSectorFeeCommunications

Request

Query Parameters

• 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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • PrimaryKey: Finds a fee record for fee communications using the specified key.
    Finder Variables:
    • FeeRecordKey; integer; The fee record key.
    • LnpRecordKey; integer; The unique identifier of the record.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• 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
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • Address1; string; The first line of the permit applicant address.
  • Address2; string; The second line of the permit applicant address.
  • Address3; string; The third line of the permit applicant address.
  • Address4; string; The fourth line of the permit applicant address.
  • ApplExpirationDate; string; The date when the application expires.
  • Applicant; integer; The party ID of the person applying for the application.
  • ApplicantBizProfileId; integer; The business profile used by the applicant.
  • ApplicantProfileId; integer; The user profile ID used by the applicant.
  • ApplicantUserId; string; The permit applicant user ID.
  • AssessedDate; string; The date when the fee item was assessed.
  • City; string; The city in the permit applicant address.
  • Classification; string; The type of record.
  • Country; string; The country in the permit applicant address.
  • County; string; The county in the permit applicant address.
  • CurrencyCode; string; The default currency code for the fee schedule.
  • DelinquentDate; string; The date when the fee becomes delinquent.
  • DepartmentDescription; string; The description of the department.
  • DueDate; string; The date when the fee item is due.
  • EmailAddress1; string; The first email address of the permit applicant.
  • EmailAddress2; string; The second email address of the permit applicant.
  • ExpirationDate; string; The date when the permit is no longer valid.
  • FeeAmount; number; The fee amount.
  • FeeDescription; string; The description of the fee item.
  • FeeItemId; string; The unique identifier for a fee that can be assessed for one or more record types.
  • FeeMemo; string; The memo content for the fee item.
  • FeeRecordKey; integer; The fee record key.
  • FeeStatus; string; The fee status.
  • Invoice; string; The fee invoice number.
  • InvoiceLine; integer; The fee invoice line number.
  • IssueDate; string; The date when the permit was issued.
  • LnpRecordId; string; 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; The key of one record.
  • OrganizationName; string; The name of the applicant business. For example, a contractor would enter the name of his or her contracting business.
  • PersonFirstName; string; The first name of the permit applicant.
  • PersonLastName; string; The last name of the permit applicant.
  • PersonMiddleName; string; The middle name of the permit applicant.
  • PersonName; string; The permit applicant name.
  • PersonNameSuffix; string; The suffix for the permit applicant. For example, Jr. or Sr.
  • PersonPreNameAdjunct; string; The salutation for the applicant. For example, Mr. or Mrs.
  • PersonTitle; string; The title of the permit applicant.
  • PhoneAreaCode; string; The area code for the permit applicant phone number.
  • PhoneCountryCode; string; The country code for the permit applicant phone number.
  • PhoneExtension; string; The permit applicant phone number extension.
  • PhoneNumber; string; The permit applicant phone number.
  • PostalCode; string; The postal code in the permit applicant address.
  • Province; string; The province in the permit applicant address.
  • RecordDescription; string; The description of the type of permit.
  • RecordStatus; string; The status of the permit record.
  • RecordType; string; The type of the permit. For example, Residential Addition.
  • RenewalDate; string; The date when the permit was renewed.
  • State; string; The state in the permit applicant address.
  • SubmitDate; string; The date when the permit application was submitted.
  • Url; string; The permit URL used within a communications template.
  • UrlLabel; string; The label displayed for a permit URL used within a communications template.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

• Metadata-Context: string
  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: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : publicSectorFeeCommunications

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/publicSectorFeeCommunications-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"Communications",
        "usage":"BusinessObject",
        "group":"psc"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorFeeCommunications-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/publicSectorFeeCommunications-item-response"
    }
}

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 : publicSectorFeeCommunications-item-response

Type: object

Show Source

• Address1: string
  Title: Applicant Address Line 1

  Read Only: true

  Maximum Length: 240

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

  Read Only: true

  Maximum Length: 240

  The second line of the permit applicant address.
• Address3: string
  Read Only: true

  Maximum Length: 240

  The third line of the permit applicant address.
• Address4: string
  Read Only: true

  Maximum Length: 240

  The fourth line of the permit applicant address.
• ApplExpirationDate: string (date-time)
  Title: Application Expiration Date

  Read Only: true

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

  The party ID of the person applying for the application.
• ApplicantBizProfileId: integer (int64)
  Read Only: true

  The business profile used by the applicant.
• ApplicantProfileId: integer (int64)
  Read Only: true

  The user profile ID used by the applicant.
• ApplicantUserId: string
  Title: Applicant User ID

  Read Only: true

  Maximum Length: 20

  The permit applicant user ID.
• AssessedDate: string (date-time)
  Title: Assessed Date

  Read Only: true

  The date when the fee item was assessed.
• City: string
  Title: Applicant City

  Read Only: true

  Maximum Length: 60

  The city in the permit applicant address.
• Classification: string
  Title: Classification

  Read Only: true

  Maximum Length: 3

  The type of record.
• Country: string
  Title: Applicant Country

  Read Only: true

  Maximum Length: 3

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

  Read Only: true

  Maximum Length: 60

  The county in the permit applicant address.
• CurrencyCode: string
  Title: Currency

  Read Only: true

  Maximum Length: 3

  The default currency code for the fee schedule.
• DelinquentDate: string (date-time)
  Title: Delinquent Date

  Read Only: true

  The date when the fee becomes delinquent.
• DepartmentDescription: string
  Title: Department

  Read Only: true

  Maximum Length: 255

  The description of the department.
• DueDate: string (date)
  Title: Due Date

  Read Only: true

  The date when the fee item is due.
• EmailAddress1: string
  Title: Applicant Email 1

  Read Only: true

  Maximum Length: 320

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

  Read Only: true

  Maximum Length: 320

  The second email address of the permit applicant.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  Read Only: true

  The date when the permit is no longer valid.
• FeeAmount: number
  Title: Amount

  Read Only: true

  The fee amount.
• FeeDescription: string
  Title: Fee Description

  Read Only: true

  Maximum Length: 50

  The description of the fee item.
• FeeItemId: string
  Title: Fee Item

  Read Only: true

  Maximum Length: 30

  The unique identifier for a fee that can be assessed for one or more record types.
• FeeMemo: string
  Title: Memo

  Read Only: true

  Maximum Length: 200

  The memo content for the fee item.
• FeeRecordKey: integer
  Read Only: true

  The fee record key.
• FeeStatus: string
  Title: Status

  Read Only: true

  Maximum Length: 6

  The fee status.
• Invoice: string
  Title: Invoice

  Read Only: true

  Maximum Length: 50

  The fee invoice number.
• InvoiceLine: integer (int64)
  Title: Invoice Line

  Read Only: true

  The fee invoice line number.
• IssueDate: string (date-time)
  Title: Issue Date

  Read Only: true

  The date when the permit was issued.
• 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 (int64)
  Read Only: true

  The key of one record.
• OrganizationName: string
  Title: Business Name

  Read Only: true

  Maximum Length: 360

  The name of the applicant business. For example, a contractor would enter the name of his or her contracting business.
• PersonFirstName: string
  Read Only: true

  Maximum Length: 150

  The first name of the permit applicant.
• PersonLastName: string
  Read Only: true

  Maximum Length: 150

  The last name of the permit applicant.
• PersonMiddleName: string
  Read Only: true

  Maximum Length: 60

  The middle name of the permit applicant.
• PersonName: string
  Title: Applicant Name

  Read Only: true

  Maximum Length: 450

  The permit applicant name.
• PersonNameSuffix: string
  Title: Suffix

  Read Only: true

  Maximum Length: 30

  The suffix for the permit applicant. For example, Jr. or Sr.
• PersonPreNameAdjunct: string
  Title: Salutation

  Read Only: true

  Maximum Length: 30

  The salutation for the applicant. For example, Mr. or Mrs.
• PersonTitle: string
  Read Only: true

  Maximum Length: 60

  The title of the permit applicant.
• PhoneAreaCode: string
  Read Only: true

  Maximum Length: 10

  The area code for the permit applicant phone number.
• PhoneCountryCode: string
  Read Only: true

  Maximum Length: 10

  The country code for the permit applicant phone number.
• PhoneExtension: string
  Title: Applicant Phone Extension

  Read Only: true

  Maximum Length: 20

  The permit applicant phone number extension.
• PhoneNumber: string
  Title: Applicant Phone Number

  Read Only: true

  Maximum Length: 40

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

  Read Only: true

  Maximum Length: 60

  The postal code in the permit applicant address.
• Province: string
  Title: Applicant Province

  Read Only: true

  Maximum Length: 60

  The province in the permit applicant address.
• RecordDescription: string
  Title: Permit Description

  Read Only: true

  Maximum Length: 300

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

  Read Only: true

  Maximum Length: 100

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

  Read Only: true

  Maximum Length: 100

  The type of the permit. For example, Residential Addition.
• RenewalDate: string (date-time)
  Title: Renewal Date

  Read Only: true

  The date when the permit was renewed.
• State: string
  Title: Applicant State

  Read Only: true

  Maximum Length: 60

  The state in the permit applicant address.
• SubmitDate: string (date-time)
  Title: Submission Date

  Read Only: true

  The date when the permit application was submitted.
• Url: string
  Title: URL

  Read Only: true

  The permit URL used within a communications template.
• UrlLabel: string
  Title: Communications URL Label

  Read Only: true

  The label displayed for a permit URL used within a communications template.

{
    "type":"object",
    "properties":{
        "ApplicantUserId":{
            "title":"Applicant User ID",
            "maxLength":20,
            "type":"string",
            "description":"The permit applicant user ID.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "UserID":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "Invoice":{
            "title":"Invoice",
            "maxLength":50,
            "type":"string",
            "description":"The fee invoice number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubmitDate":{
            "title":"Submission Date",
            "type":"string",
            "description":"The date when the permit application was submitted.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EmailAddress1":{
            "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"
            },
            "x-queryable":true
        },
        "EmailAddress2":{
            "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"
            },
            "x-queryable":true
        },
        "PersonMiddleName":{
            "maxLength":60,
            "type":"string",
            "description":"The middle name of the permit applicant.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonTitle":{
            "maxLength":60,
            "type":"string",
            "description":"The title of the permit applicant.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":3,
            "type":"string",
            "description":"The default currency code for the fee schedule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FeeItemId":{
            "title":"Fee Item",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for a fee that can be assessed for one or more record types.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssessedDate":{
            "title":"Assessed Date",
            "type":"string",
            "description":"The date when the fee item was assessed.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Classification":{
            "title":"Classification",
            "maxLength":3,
            "type":"string",
            "description":"The type of record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UrlLabel":{
            "title":"Communications URL Label",
            "type":"string",
            "description":"The label displayed for a permit URL used within a communications template.",
            "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"
            }
        },
        "RecordDescription":{
            "title":"Permit Description",
            "maxLength":300,
            "type":"string",
            "description":"The description of the type of permit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantProfileId":{
            "type":"integer",
            "description":"The user profile ID used by the applicant.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PersonLastName":{
            "maxLength":150,
            "type":"string",
            "description":"The last name of the permit applicant.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InvoiceLine":{
            "title":"Invoice Line",
            "type":"integer",
            "description":"The fee invoice line number.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PersonFirstName":{
            "maxLength":150,
            "type":"string",
            "description":"The first name of the permit applicant.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "City":{
            "title":"Applicant City",
            "maxLength":60,
            "type":"string",
            "description":"The city in the permit applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"The key of one record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Province":{
            "title":"Applicant Province",
            "maxLength":60,
            "type":"string",
            "description":"The province in the permit applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PhoneExtension":{
            "title":"Applicant Phone Extension",
            "maxLength":20,
            "type":"string",
            "description":"The permit applicant phone number extension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RenewalDate":{
            "title":"Renewal Date",
            "type":"string",
            "description":"The date when the permit was renewed.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "State":{
            "title":"Applicant State",
            "maxLength":60,
            "type":"string",
            "description":"The state in the permit applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Country":{
            "title":"Applicant Country",
            "maxLength":3,
            "type":"string",
            "description":"The country in the permit applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FeeDescription":{
            "title":"Fee Description",
            "maxLength":50,
            "type":"string",
            "description":"The description of the fee item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Applicant":{
            "type":"integer",
            "description":"The party ID of the person applying for the application.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrganizationName":{
            "title":"Business Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the applicant business. For example, a contractor would enter the name of his or her contracting business.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FeeMemo":{
            "title":"Memo",
            "maxLength":200,
            "type":"string",
            "description":"The memo content for the fee item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonNameSuffix":{
            "title":"Suffix",
            "maxLength":30,
            "type":"string",
            "description":"The suffix for the permit applicant. For example, Jr. or Sr.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PostalCode":{
            "title":"Applicant Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"The postal code in the permit applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DepartmentDescription":{
            "title":"Department",
            "maxLength":255,
            "type":"string",
            "description":"The description of the department.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "County":{
            "title":"Applicant County",
            "maxLength":60,
            "type":"string",
            "description":"The county in the permit applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplExpirationDate":{
            "title":"Application Expiration Date",
            "type":"string",
            "description":"The date when the application expires.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Url":{
            "title":"URL",
            "type":"string",
            "description":"The permit URL used within a communications template.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PhoneCountryCode":{
            "maxLength":10,
            "type":"string",
            "description":"The country code for the permit applicant phone number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PhoneAreaCode":{
            "maxLength":10,
            "type":"string",
            "description":"The area code for the permit applicant phone number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DelinquentDate":{
            "title":"Delinquent Date",
            "type":"string",
            "description":"The date when the fee becomes delinquent.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordType":{
            "title":"Permit Type",
            "maxLength":100,
            "type":"string",
            "description":"The type of the permit. For example, Residential Addition.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Address4":{
            "maxLength":240,
            "type":"string",
            "description":"The fourth line of the permit applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DueDate":{
            "title":"Due Date",
            "type":"string",
            "description":"The date when the fee item is due.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FeeAmount":{
            "title":"Amount",
            "type":"number",
            "description":"The fee amount.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Amount":"Y",
                "AmountDispProp":"Y"
            },
            "x-queryable":true
        },
        "RecordStatus":{
            "title":"Permit Status",
            "maxLength":100,
            "type":"string",
            "description":"The status of the permit record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonPreNameAdjunct":{
            "title":"Salutation",
            "maxLength":30,
            "type":"string",
            "description":"The salutation for the applicant. For example, Mr. or Mrs.",
            "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-queryable":true
        },
        "PersonName":{
            "title":"Applicant Name",
            "maxLength":450,
            "type":"string",
            "description":"The permit applicant name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address2":{
            "title":"Applicant Address Line 2",
            "maxLength":240,
            "type":"string",
            "description":"The second line of the permit applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address3":{
            "maxLength":240,
            "type":"string",
            "description":"The third line of the permit applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IssueDate":{
            "title":"Issue Date",
            "type":"string",
            "description":"The date when the permit was issued.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address1":{
            "title":"Applicant Address Line 1",
            "maxLength":240,
            "type":"string",
            "description":"The first line of the permit applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FeeStatus":{
            "title":"Status",
            "maxLength":6,
            "type":"string",
            "description":"The fee status.",
            "nullable":false,
            "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
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The date when the permit is no longer valid.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FeeRecordKey":{
            "type":"integer",
            "description":"The fee record key.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PhoneNumber":{
            "title":"Applicant Phone Number",
            "maxLength":40,
            "type":"string",
            "description":"The permit applicant phone number.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Phone":"Y",
                "Recipient":"Y"
            },
            "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