Jump to

• Request
• Response

Get a business license expiry communication item

get

/fscmRestApi/resources/11.13.18.05/publicSectorBlExpiryCommunications/{LnpRecordKey}

Request

Path Parameters

• LnpRecordKey(required): integer(int64)
  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 : publicSectorBlExpiryCommunications-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.
• Address1: string
  Title: Applicant Address Line 1

  Read Only: true

  Maximum Length: 240

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

  Read Only: true

  Maximum Length: 240

  The second line of the business license applicant address.
• AgencyId: integer (int32)
  Title: Agency ID

  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.
• AltPhoneAreaCode: string
  Read Only: true

  Maximum Length: 10

  The alternate phone area code in the business license mailing address.
• AltPhoneCountryCode: string
  Read Only: true

  Maximum Length: 10

  The alternate phone country code in the business license mailing address.
• AltPhoneExtension: string
  Read Only: true

  Maximum Length: 20

  The alternate phone extension in the business license mailing address.
• AltPhoneNumber: string
  Read Only: true

  Maximum Length: 40

  The alternate phone number in the business license mailing address.
• ApplAteDate: string (date-time)
  Read Only: true

  The date to indicate when the application is about to expire.
• ApplExpirationDate: string (date-time)
  Title: Application Expiration Date

  Read Only: true

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

  Read Only: true

  The party identifier of the business license applicant.
• AssignedSpecialistEmail: string
  Title: Assigned Specialist Email

  Read Only: true

  Maximum Length: 255

  The email of the specialist assigned to the application.
• AssignedSpecialistName: string
  Title: Assigned Specialist Name

  Read Only: true

  Maximum Length: 255

  The name of the specialist assigned to the application.
• AssignedSpecialistUserid: string
  Title: Assigned Specialist User ID

  Read Only: true

  Maximum Length: 64

  The user ID of the specialist assigned to the application.
• Balancedue: number
  Title: Total Due

  Read Only: true

  The application balance due amount.
• BusAddress1: string
  Title: Address 1

  Read Only: true

  Maximum Length: 240

  The first line of the business license location address.
• BusAddress2: string
  Title: Address 2

  Read Only: true

  Maximum Length: 240

  The second line of the business license location address.
• BusagentAddress1: string
  Read Only: true

  Maximum Length: 240

  The first line of the business entity authorized agent address.
• BusagentAddress2: string
  Read Only: true

  Maximum Length: 240

  The second line of the business entity authorized agent address.
• BusagentCity: string
  Read Only: true

  Maximum Length: 60

  The city of the business entity authorized agent address.
• BusagentCountry: string
  Read Only: true

  Maximum Length: 60

  The country of the business entity authorized agent address.
• BusagentCounty: string
  Read Only: true

  Maximum Length: 60

  The county of the business entity authorized agent address.
• BusagentEmailAddress: string
  Read Only: true

  Maximum Length: 320

  The email address of the business entity authorized agent.
• BusagentPersonName: string
  Read Only: true

  Maximum Length: 450

  The name of the business entity authorized agent.
• BusagentPhoneAreaCode: string
  Read Only: true

  Maximum Length: 10

  The phone area code of the business entity authorized agent.
• BusagentPhoneCountryCode: string
  Read Only: true

  Maximum Length: 10

  The phone country code of the business entity authorized agent.
• BusagentPhoneExtension: string
  Read Only: true

  Maximum Length: 40

  The phone extension of the business entity authorized agent.
• BusagentPhoneNumber: string
  Read Only: true

  Maximum Length: 40

  The phone number of the business entity authorized agent.
• BusagentPostalCode: string
  Read Only: true

  Maximum Length: 60

  The postal code of the business entity authorized agent address.
• BusagentProvince: string
  Read Only: true

  Maximum Length: 60

  The province of the business entity authorized agent address.
• BusagentState: string
  Read Only: true

  Maximum Length: 60

  The state of the business entity authorized agent address.
• BusBusinessLegalName: string
  Title: Legal Name

  Read Only: true

  Maximum Length: 240

  The legal name of the business entity.
• BusCategory: string
  Title: Category

  Read Only: true

  Maximum Length: 50

  The category of the business location.
• BusCity: string
  Title: City

  Read Only: true

  Maximum Length: 60

  The city in the business license location address.
• BusDbaBusinessName: string
  Title: Doing Business As

  Read Only: true

  Maximum Length: 100

  The DBA business name of the business location.
• BusDescription: string
  Title: Business Description

  Read Only: true

  Maximum Length: 200

  The description of the business location.
• BusDisadvOwnedFlag: string
  Title: Disadvantaged Enterprise Owned

  Read Only: true

  Maximum Length: 1

  Indicates if a person with disadvantage owns the business entity.
• BusExemptFlag: string
  Read Only: true

  Maximum Length: 1

  The tax exempt flag of the business entity.
• BusExemptPct: number
  Read Only: true

  The tax exemption percentage of the business entity.
• BusExemptType: string
  Read Only: true

  Maximum Length: 30

  The tax exemption type of the business entity.
• BusFemaleOwnedFlag: string
  Title: Female Owned

  Read Only: true

  Maximum Length: 1

  Indicates if a female owns the business entity.
• BuslocCountry: string
  Title: Country

  Read Only: true

  Maximum Length: 3

  The country in the business license location address.
• BuslocEmailAddress: string
  Read Only: true

  Maximum Length: 320

  The email address of the business location.
• BuslocPostalCode: string
  Title: Postal Code

  Read Only: true

  Maximum Length: 60

  The postal code in the business license location address.
• BuslocProvince: string
  Title: Province

  Read Only: true

  Maximum Length: 60

  The province in the business license applicant address.
• BuslocState: string
  Title: State

  Read Only: true

  Maximum Length: 60

  The state in the business license location address.
• BusMinorityOwnedFlag: string
  Title: Minority Owned

  Read Only: true

  Maximum Length: 1

  Indicates if a person from minority group owns the business entity.
• BusNaicsCode: string
  Read Only: true

  Maximum Length: 30

  The NAICS code of business license.
• BusownAddress1: string
  Read Only: true

  Maximum Length: 240

  The first line of the business entity owner address.
• BusownAddress2: string
  Read Only: true

  Maximum Length: 240

  The second line of the business entity owner address.
• BusownCity: string
  Read Only: true

  Maximum Length: 60

  The city of the business entity owner address.
• BusownCountry: string
  Read Only: true

  Maximum Length: 3

  The country of the business entity owner.
• BusownCounty: string
  Read Only: true

  Maximum Length: 60

  The county of the business entity owner address.
• BusownEmailAddress: string
  Read Only: true

  Maximum Length: 320

  The email address of the business entity owner address.
• BusownMailingAddress1: string
  Read Only: true

  Maximum Length: 240

  The first line of the business entity owner mailing address.
• BusownMailingAddress2: string
  Read Only: true

  Maximum Length: 240

  The second line of the business entity owner mailing address.
• BusownMailingCity: string
  Read Only: true

  Maximum Length: 60

  The city of the business entity owner mailing address.
• BusownMailingCountry: string
  Read Only: true

  Maximum Length: 3

  The country of the business entity owner mailing address.
• BusownMailingCounty: string
  Read Only: true

  Maximum Length: 60

  The county of the business entity owner mailing address.
• BusownMailingPostalCode: string
  Read Only: true

  Maximum Length: 60

  The postal code of the business entity owner mailing address.
• BusownMailingProvince: string
  Read Only: true

  Maximum Length: 60

  The province of the business entity owner mailing address.
• BusownMailingState: string
  Read Only: true

  Maximum Length: 60

  The state of the business entity owner mailing address.
• BusownPersonName: string
  Read Only: true

  Maximum Length: 450

  The name of the business entity owner.
• BusownPhoneAreaCode: string
  Read Only: true

  Maximum Length: 10

  The phone area code of the business entity owner address.
• BusownPhoneCountryCode: string
  Read Only: true

  Maximum Length: 10

  The phone country code of the business entity owner address.
• BusownPhoneExtension: string
  Read Only: true

  Maximum Length: 20

  The phone extension of the business entity owner address.
• BusownPhoneNumber: string
  Read Only: true

  Maximum Length: 40

  The phone number of the business entity owner address.
• BusownPostalCode: string
  Read Only: true

  Maximum Length: 60

  The postal code of the business entity owner address.
• BusownProvince: string
  Read Only: true

  Maximum Length: 60

  The province of the business entity owner address.
• BusownState: string
  Read Only: true

  Maximum Length: 60

  The state of the business entity owner address.
• BusSmallBusFlag: string
  Read Only: true

  Maximum Length: 1

  Indicates if the business entity is a small business.
• BusSubCategory: string
  Title: Subcategory

  Read Only: true

  Maximum Length: 50

  The sub category of the business location.
• BusVeteranOwnedFlag: string
  Read Only: true

  Maximum Length: 1

  Indicates if a veteran owns the business entity.
• City: string
  Title: Applicant City

  Read Only: true

  Maximum Length: 60

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

  Read Only: true

  Maximum Length: 3

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

  Read Only: true

  Maximum Length: 3

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

  Read Only: true

  Maximum Length: 60

  The county in the business license applicant address.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

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

  Read Only: true

  The date the license becomes delinquent.
• Description: string
  Title: Description

  Read Only: true

  Maximum Length: 100

  The status of the business license record.
• EmailAddress1: string
  Title: Applicant Email 1

  Read Only: true

  Maximum Length: 320

  The first email address of the business license applicant.
• EmailAddress2: string
  Read Only: true

  Maximum Length: 320

  The second email address of the business license applicant.
• 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 End Date

  Read Only: true

  The application expiry grace date.
• GracePeriod: integer (int64)
  Title: Grace Period

  Read Only: true

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

  Read Only: true

  Maximum Length: 5

  The grace period unit for the application expiry.
• IssueDate: string (date-time)
  Title: Issued On

  Read Only: true

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

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

  The date when the record was created.
• LicDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 1000

  The description of the business license type.
• LicenseFinancialStatus: string
  Read Only: true

  Maximum Length: 30

  The financial status of business license.
• LicenseStatus: string
  Title: Status

  Read Only: true

  Maximum Length: 30

  The status of business license.
• links: array Links
  Title: Links

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

  Read Only: true

  Maximum Length: 50

  The identifier for the business license record. For example, a license number with a value such as Business License ID RA-2017-00029.
• LnpRecordKey: integer (int64)
  Read Only: true

  The unique identifier for the record.
• MailingAddress1: string
  Read Only: true

  Maximum Length: 240

  The first line of the business license mailing address.
• MailingAddress2: string
  Read Only: true

  Maximum Length: 240

  The second line of the business license mailing address.
• MailingCity: string
  Read Only: true

  Maximum Length: 60

  The city in the business license mailing address.
• MailingCountry: string
  Read Only: true

  Maximum Length: 3

  The country in the business license mailing address.
• MailingCounty: string
  Read Only: true

  Maximum Length: 60

  The county in the business license mailing address.
• MailingPostalCode: string
  Read Only: true

  Maximum Length: 60

  The postal code in the business license mailing address.
• MailingPostalPlusFourCode: string
  Read Only: true

  Maximum Length: 10

  The postal plus code in the business license mailing address.
• MailingProvince: string
  Read Only: true

  Maximum Length: 60

  The province in the business license mailing address.
• MailingState: string
  Read Only: true

  Maximum Length: 60

  The state in the business license mailing address.
• OriginalIssueDate: string (date-time)
  Read Only: true

  The original issue date of business license.
• PersonName: string
  Title: Applicant Name

  Read Only: true

  Maximum Length: 450

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

  Maximum Length: 10

  The area code in the phone number of the business license applicant.
• PhoneCountryCode: string
  Read Only: true

  Maximum Length: 10

  The country code in the phone number of the business license applicant.
• PhoneExtension: string
  Title: Applicant Phone Extension

  Read Only: true

  Maximum Length: 20

  The phone number extension of the business license applicant.
• 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 business license applicant address.
• Primarycontactemail: string
  Title: Contact Email

  Read Only: true

  Maximum Length: 320

  The application primary contact email.
• Primarycontactname: string
  Title: Location Contact

  Read Only: true

  Maximum Length: 450

  The application primary contact name.
• Primarycontactphone: string
  Title: Contact Phone Number

  Read Only: true

  Maximum Length: 60

  The application primary contact phone.
• PrimaryPhoneAreaCode: string
  Read Only: true

  Maximum Length: 10

  The primary phone area code in the business license mailing address.
• PrimaryPhoneCountryCode: string
  Read Only: true

  Maximum Length: 10

  The primary phone country code in the business license mailing address.
• PrimaryPhoneExtension: string
  Read Only: true

  Maximum Length: 20

  The primary phone extension in the business license mailing address.
• PrimaryPhoneNumber: string
  Read Only: true

  Maximum Length: 40

  The primary phone number in the business license mailing address.
• ProjectKey: integer (int64)
  Title: Project

  Read Only: true

  The project name information for a business license.
• Province: string
  Title: Applicant Province

  Read Only: true

  Maximum Length: 60

  The province in the business license applicant address.
• RecordStatus: string
  Title: Status

  Read Only: true

  Maximum Length: 15

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

  Read Only: true

  Maximum Length: 100

  The business license type. Agencies define the types of licenses that they administer.
• RenewalDate: string (date-time)
  Title: Renewal Date

  Read Only: true

  The renewal date for the license or permit.
• State: string
  Title: Applicant State

  Read Only: true

  Maximum Length: 60

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

  Read Only: true

  The date the license and business license transaction was submitted. Used in the application information component of the Business License Designer.
• SubmittedBy: string
  Title: Submitted By

  Read Only: true

  Maximum Length: 64

  The user who submitted the application.
• Url: string
  Title: URL

  Read Only: true

  Maximum Length: 255

  The browser link for the business license application.
• UrlLabel: string
  Title: Link to Business License Activity

  Read Only: true

  Maximum Length: 255

  The label for the URL.
• Username: string
  Title: Applicant User ID

  Read Only: true

  Maximum Length: 100

  The user ID of the business license applicant.

{
    "type":"object",
    "properties":{
        "BusDescription":{
            "title":"Business Description",
            "maxLength":200,
            "type":"string",
            "description":"The description of the business location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "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":"The user who last updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BusownMailingAddress2":{
            "maxLength":240,
            "type":"string",
            "description":"The second line of the business entity owner mailing address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusownMailingAddress1":{
            "maxLength":240,
            "type":"string",
            "description":"The first line of the business entity owner mailing address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubmitDate":{
            "title":"Submission Date",
            "type":"string",
            "description":"The date the license and business license transaction was submitted. Used in the application information component of the Business License Designer.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusagentPersonName":{
            "maxLength":450,
            "type":"string",
            "description":"The name of the business entity authorized agent.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedSpecialistUserid":{
            "title":"Assigned Specialist User ID",
            "maxLength":64,
            "type":"string",
            "description":"The user ID of the specialist assigned to the application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "UserID":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "Primarycontactemail":{
            "title":"Contact Email",
            "maxLength":320,
            "type":"string",
            "description":"The application primary contact email.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Email":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "BusownMailingCountry":{
            "maxLength":3,
            "type":"string",
            "description":"The country of the business entity owner mailing address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Classification":{
            "title":"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
        },
        "GracePeriodUom":{
            "title":"Grace Period UOM",
            "maxLength":5,
            "type":"string",
            "description":"The grace period unit for the application expiry.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UrlLabel":{
            "title":"Link to Business License Activity",
            "maxLength":255,
            "type":"string",
            "description":"The label for the URL.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "URLLabel":"Y"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The date when the record was created.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "UserID":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "BusExemptType":{
            "maxLength":30,
            "type":"string",
            "description":"The tax exemption type of the business entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "UserID":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "PrimaryPhoneAreaCode":{
            "maxLength":10,
            "type":"string",
            "description":"The primary phone area code in the business license mailing address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusBusinessLegalName":{
            "title":"Legal Name",
            "maxLength":240,
            "type":"string",
            "description":"The legal name of the business entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusagentAddress2":{
            "maxLength":240,
            "type":"string",
            "description":"The second line of the business entity authorized agent address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusagentAddress1":{
            "maxLength":240,
            "type":"string",
            "description":"The first line of the business entity authorized agent address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubmittedBy":{
            "title":"Submitted By",
            "maxLength":64,
            "type":"string",
            "description":"The user who submitted the application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "UserID":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "BusownPersonName":{
            "maxLength":450,
            "type":"string",
            "description":"The name of the business entity owner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MailingCity":{
            "maxLength":60,
            "type":"string",
            "description":"The city in the business license mailing address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"The unique identifier for the record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BusownCounty":{
            "maxLength":60,
            "type":"string",
            "description":"The county of the business entity owner address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PhoneExtension":{
            "title":"Applicant Phone Extension",
            "maxLength":20,
            "type":"string",
            "description":"The phone number extension of the business license applicant.",
            "nullable":true,
            "readOnly":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-queryable":true
        },
        "ExpirationGraceDate":{
            "title":"Grace Period End Date",
            "type":"string",
            "description":"The application expiry grace date.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryPhoneNumber":{
            "maxLength":40,
            "type":"string",
            "description":"The primary phone number in the business license mailing address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Phone":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "BusagentPhoneAreaCode":{
            "maxLength":10,
            "type":"string",
            "description":"The phone area code of the business entity authorized agent.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Country":{
            "title":"Applicant Country",
            "maxLength":3,
            "type":"string",
            "description":"The country in the business license applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GracePeriod":{
            "title":"Grace Period",
            "type":"integer",
            "description":"The grace period for the application expiry.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":10
            },
            "x-queryable":true
        },
        "Applicant":{
            "title":"Applicant",
            "type":"integer",
            "description":"The party identifier of the business license applicant.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":100,
            "type":"string",
            "description":"The status of the business license record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "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
            },
            "x-queryable":true
        },
        "BusAddress2":{
            "title":"Address 2",
            "maxLength":240,
            "type":"string",
            "description":"The second line of the business license location address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusagentPhoneExtension":{
            "maxLength":40,
            "type":"string",
            "description":"The phone extension of the business entity authorized agent.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusAddress1":{
            "title":"Address 1",
            "maxLength":240,
            "type":"string",
            "description":"The first line of the business license location address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MailingCountry":{
            "maxLength":3,
            "type":"string",
            "description":"The country in the business license mailing address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MailingCounty":{
            "maxLength":60,
            "type":"string",
            "description":"The county in the business license mailing 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
        },
        "MailingState":{
            "maxLength":60,
            "type":"string",
            "description":"The state in the business license mailing address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Url":{
            "title":"URL",
            "maxLength":255,
            "type":"string",
            "description":"The browser link for the business license application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "URL":"Y"
            },
            "x-queryable":true
        },
        "LicDescription":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"The description of the business license type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DelinquentDate":{
            "title":"Delinquent Date",
            "type":"string",
            "description":"The date the license becomes delinquent.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryPhoneExtension":{
            "maxLength":20,
            "type":"string",
            "description":"The primary phone extension in the business license mailing address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusagentCity":{
            "maxLength":60,
            "type":"string",
            "description":"The city of the business entity authorized agent address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BuslocCountry":{
            "title":"Country",
            "maxLength":3,
            "type":"string",
            "description":"The country in the business license location address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusDisadvOwnedFlag":{
            "title":"Disadvantaged Enterprise Owned",
            "maxLength":1,
            "type":"string",
            "description":"Indicates if a person with disadvantage owns the business entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MailingAddress1":{
            "maxLength":240,
            "type":"string",
            "description":"The first line of the business license mailing address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MailingAddress2":{
            "maxLength":240,
            "type":"string",
            "description":"The second line of the business license mailing address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordStatus":{
            "title":"Status",
            "maxLength":15,
            "type":"string",
            "description":"The status of the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BusCategory":{
            "title":"Category",
            "maxLength":50,
            "type":"string",
            "description":"The category of the business location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BuslocState":{
            "title":"State",
            "maxLength":60,
            "type":"string",
            "description":"The state in the business license location address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MailingProvince":{
            "maxLength":60,
            "type":"string",
            "description":"The province in the business license mailing address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusownState":{
            "maxLength":60,
            "type":"string",
            "description":"The state of the business entity owner address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusagentState":{
            "maxLength":60,
            "type":"string",
            "description":"The state of the business entity authorized agent address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusDbaBusinessName":{
            "title":"Doing Business As",
            "maxLength":100,
            "type":"string",
            "description":"The DBA business name of the business location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusSmallBusFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the business entity is a small business.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IssueDate":{
            "title":"Issued On",
            "type":"string",
            "description":"The date the license or permit was issued. Used in the application information component of the Business License Designer.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AltPhoneNumber":{
            "maxLength":40,
            "type":"string",
            "description":"The alternate phone number in the business license mailing address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Phone":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "ApplAteDate":{
            "type":"string",
            "description":"The date to indicate when the application is about to expire.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryPhoneCountryCode":{
            "maxLength":10,
            "type":"string",
            "description":"The primary phone country code in the business license mailing address.",
            "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
        },
        "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
        },
        "BusownMailingProvince":{
            "maxLength":60,
            "type":"string",
            "description":"The province of the business entity owner mailing address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusSubCategory":{
            "title":"Subcategory",
            "maxLength":50,
            "type":"string",
            "description":"The sub category of the business location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusagentPhoneNumber":{
            "maxLength":40,
            "type":"string",
            "description":"The phone number of the business entity authorized agent.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Phone":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BusExemptFlag":{
            "maxLength":1,
            "type":"string",
            "description":"The tax exempt flag of the business entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusownMailingCounty":{
            "maxLength":60,
            "type":"string",
            "description":"The county of the business entity owner mailing address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusVeteranOwnedFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if a veteran owns the business entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusagentCounty":{
            "maxLength":60,
            "type":"string",
            "description":"The county of the business entity authorized agent address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusExemptPct":{
            "type":"number",
            "description":"The tax exemption percentage of the business entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EmailAddress1":{
            "title":"Applicant Email 1",
            "maxLength":320,
            "type":"string",
            "description":"The first email address of the business license applicant.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Email":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "OriginalIssueDate":{
            "type":"string",
            "description":"The original issue date of business license.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EmailAddress2":{
            "maxLength":320,
            "type":"string",
            "description":"The second email address of the business license applicant.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Email":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "AltPhoneExtension":{
            "maxLength":20,
            "type":"string",
            "description":"The alternate phone extension in the business license mailing address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AltPhoneCountryCode":{
            "maxLength":10,
            "type":"string",
            "description":"The alternate phone country code in the business license mailing address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MailingPostalPlusFourCode":{
            "maxLength":10,
            "type":"string",
            "description":"The postal plus code in the business license mailing address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BuslocProvince":{
            "title":"Province",
            "maxLength":60,
            "type":"string",
            "description":"The province in the business license applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusagentProvince":{
            "maxLength":60,
            "type":"string",
            "description":"The province of the business entity authorized agent address.",
            "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"
            }
        },
        "BuslocEmailAddress":{
            "maxLength":320,
            "type":"string",
            "description":"The email address of the business location.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Email":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "BusownMailingPostalCode":{
            "maxLength":60,
            "type":"string",
            "description":"The postal code of the business entity owner mailing address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusCity":{
            "title":"City",
            "maxLength":60,
            "type":"string",
            "description":"The city in the business license location address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusagentEmailAddress":{
            "maxLength":320,
            "type":"string",
            "description":"The email address of the business entity authorized agent.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Email":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "BusagentPostalCode":{
            "maxLength":60,
            "type":"string",
            "description":"The postal code of the business entity authorized agent address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusagentPhoneCountryCode":{
            "maxLength":10,
            "type":"string",
            "description":"The phone country code of the business entity authorized agent.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "City":{
            "title":"Applicant City",
            "maxLength":60,
            "type":"string",
            "description":"The city in the business license applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BuslocPostalCode":{
            "title":"Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"The postal code in the business license location address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusownPhoneExtension":{
            "maxLength":20,
            "type":"string",
            "description":"The phone extension of the business entity owner address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Province":{
            "title":"Applicant Province",
            "maxLength":60,
            "type":"string",
            "description":"The province in the business license applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "State":{
            "title":"Applicant State",
            "maxLength":60,
            "type":"string",
            "description":"The state in the business license applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LicenseStatus":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of business license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusownEmailAddress":{
            "maxLength":320,
            "type":"string",
            "description":"The email address of the business entity owner address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Email":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "ProjectKey":{
            "title":"Project",
            "type":"integer",
            "description":"The project name information for a business license.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BusownPostalCode":{
            "maxLength":60,
            "type":"string",
            "description":"The postal code of the business entity owner address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusFemaleOwnedFlag":{
            "title":"Female Owned",
            "maxLength":1,
            "type":"string",
            "description":"Indicates if a female owns the business entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LicenseFinancialStatus":{
            "maxLength":30,
            "type":"string",
            "description":"The financial status of business license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Balancedue":{
            "title":"Total Due",
            "type":"number",
            "description":"The application balance due amount.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Amount":"Y"
            },
            "x-queryable":true
        },
        "PostalCode":{
            "title":"Applicant Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"The postal code in the business license applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusownAddress1":{
            "maxLength":240,
            "type":"string",
            "description":"The first line of the business entity owner address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusownAddress2":{
            "maxLength":240,
            "type":"string",
            "description":"The second line of the business entity owner address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "County":{
            "title":"Applicant County",
            "maxLength":60,
            "type":"string",
            "description":"The county in the business license applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PhoneCountryCode":{
            "maxLength":10,
            "type":"string",
            "description":"The country code in the phone number of the business license applicant.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PhoneAreaCode":{
            "maxLength":10,
            "type":"string",
            "description":"The area code in the phone number of the business license applicant.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordType":{
            "title":"License Type",
            "maxLength":100,
            "type":"string",
            "description":"The business license type. Agencies define the types of licenses that they administer.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Primarycontactphone":{
            "title":"Contact Phone Number",
            "maxLength":60,
            "type":"string",
            "description":"The application primary contact phone.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Phone":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "MailingPostalCode":{
            "maxLength":60,
            "type":"string",
            "description":"The postal code in the business license mailing address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Primarycontactname":{
            "title":"Location Contact",
            "maxLength":450,
            "type":"string",
            "description":"The application primary contact name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedSpecialistName":{
            "title":"Assigned Specialist Name",
            "maxLength":255,
            "type":"string",
            "description":"The name of the specialist assigned to the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusownMailingCity":{
            "maxLength":60,
            "type":"string",
            "description":"The city of the business entity owner mailing address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedSpecialistEmail":{
            "title":"Assigned Specialist Email",
            "maxLength":255,
            "type":"string",
            "description":"The email of the specialist assigned to the application.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Email":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "BusNaicsCode":{
            "maxLength":30,
            "type":"string",
            "description":"The NAICS code of business license.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusownCity":{
            "maxLength":60,
            "type":"string",
            "description":"The city of the business entity owner address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordId":{
            "title":"Application ID",
            "maxLength":50,
            "type":"string",
            "description":"The identifier for the business license record. For example, a license number with a value such as Business License 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
        },
        "BusownProvince":{
            "maxLength":60,
            "type":"string",
            "description":"The province of the business entity owner address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusagentCountry":{
            "maxLength":60,
            "type":"string",
            "description":"The country of the business entity authorized agent address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusMinorityOwnedFlag":{
            "title":"Minority Owned",
            "maxLength":1,
            "type":"string",
            "description":"Indicates if a person from minority group owns the business entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address2":{
            "title":"Applicant Address Line 2",
            "maxLength":240,
            "type":"string",
            "description":"The second line of the business license applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusownPhoneAreaCode":{
            "maxLength":10,
            "type":"string",
            "description":"The phone area code of the business entity owner address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address1":{
            "title":"Applicant Address Line 1",
            "maxLength":240,
            "type":"string",
            "description":"The first line of the business license applicant address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusownPhoneNumber":{
            "maxLength":40,
            "type":"string",
            "description":"The phone number of the business entity owner address.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "Phone":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "AltPhoneAreaCode":{
            "maxLength":10,
            "type":"string",
            "description":"The alternate phone area code in the business license mailing address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusownPhoneCountryCode":{
            "maxLength":10,
            "type":"string",
            "description":"The phone country code of the business entity owner address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Username":{
            "title":"Applicant User ID",
            "maxLength":100,
            "type":"string",
            "description":"The user ID of the business license applicant.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "UserID":"Y",
                "Recipient":"Y"
            },
            "x-queryable":true
        },
        "BusownMailingState":{
            "maxLength":60,
            "type":"string",
            "description":"The state of the business entity owner mailing address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusownCountry":{
            "maxLength":3,
            "type":"string",
            "description":"The country of the business entity owner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

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

Nested Schema : properties

Type: object

Show Source

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

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

Back to Top