Jump to

• Request
• Response

Create a business license record

post

/fscmRestApi/resources/11.13.18.05/publicSectorAboutToExpireBlLocationLicenses

Request

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

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

Type: object

Show Source

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

  Read Only: true

  Indicates the date when an issued business license is about to expire.
• BusDbaBusinessName: string
  Title: Doing Business As

  Read Only: true

  Maximum Length: 100

  The doing business as name for the business.
• BusDescription: string
  Title: Location Business Description

  Read Only: true

  Maximum Length: 200

  The description of the business.
• BusinessEntityId: string
  Read Only: true

  Maximum Length: 50

  Meaningful identifier for the business entity.
• BusinessEntityKey: integer (int64)
  Read Only: true

  The unique identifier for the business entity.
• BusinessLocationId: string
  Title: Location ID

  Read Only: true

  Maximum Length: 50

  Meaningful identifier for the business location.
• BusinessLocationKey: integer (int64)
  Read Only: true

  Unique identifier for the transaction business location.
• CurrencyCode: string
  Title: Currency Code

  Read Only: true

  Maximum Length: 3

  The currency code used for applying payments.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  Read Only: true

  The date when the business license expires.
• ExpirationGraceDate: string (date-time)
  Title: Expiration Grace Date

  Read Only: true

  Indicates the new date that the business license can be extended.
• IssueDate: string (date-time)
  Title: Issue Date

  Read Only: true

  The date when the business license application was issued.
• LicenseId: string
  Title: License ID

  Read Only: true

  Maximum Length: 50

  Meaningful identifier for the business license transaction.
• LicensePeriod: string
  Title: License Period

  Read Only: true

  Maximum Length: 100

  The period that applies to the business license transaction.
• LicenseStatus: string
  Title: License Status

  Read Only: true

  Maximum Length: 30

  The overall status of the business.
• LicenseType: string
  Title: License Type

  Read Only: true

  Maximum Length: 100

  The user-friendly name for the business license type.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocationAddress: string
  Title: Address

  Read Only: true

  Maximum Length: 900

  Full business location address contains address line 1, address line 2, address Line 3, city, state, and postal code.
• LocationMailingAddress: string
  Title: Mailing Address

  Read Only: true

  Maximum Length: 900

  Full location mailing address contains address line 1, address line 2, address line 3, city, state, and postal code.
• RenewalDate: string (date-time)
  Title: Renewal Date

  Read Only: true

  Indicates the date when an issued business license was renewed.
• TotalFees: number
  Title: Total Fees

  Read Only: true

  The total amount of fees for this business license record.
• TotalFeesDue: number
  Title: Balance Due

  Read Only: true

  The amount of fees that are currently due for this business license record.
• TotalFeesPaid: number
  Title: Fees Total Paid

  Read Only: true

  The amount paid toward the total fees for this business license record.
• TotalPayable: number
  Title: Fees Total Payable

  Read Only: true

  The amount of fees that are payable for this business license record.
• Url: string
  Read Only: true

  Maximum Length: 255

  The URL provides a link that the user can click to navigate to other pages with more information.
• UrlLabel: string
  Title: URL

  Read Only: true

  Maximum Length: 255

  Meaningful label for the URL.

{
    "type":"object",
    "properties":{
        "BusDescription":{
            "title":"Location Business Description",
            "maxLength":"200",
            "type":"string",
            "description":"The description of the business.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AboutToExpireDate":{
            "title":"About to Expire Date",
            "type":"string",
            "description":"Indicates the date when an issued business license is about to expire.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessEntityId":{
            "maxLength":"50",
            "type":"string",
            "description":"Meaningful identifier for the business entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationMailingAddress":{
            "title":"Mailing Address",
            "maxLength":"900",
            "type":"string",
            "description":"Full location mailing address contains address line 1, address line 2, address line 3, city, state, and postal code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalFeesPaid":{
            "title":"Fees Total Paid",
            "type":"number",
            "description":"The amount paid toward the total fees for this business license record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalPayable":{
            "title":"Fees Total Payable",
            "type":"number",
            "description":"The amount of fees that are payable for this business license record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LicenseId":{
            "title":"License ID",
            "maxLength":"50",
            "type":"string",
            "description":"Meaningful identifier for the business license transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Url":{
            "maxLength":"255",
            "type":"string",
            "description":"The URL provides a link that the user can click to navigate to other pages with more information.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LicenseType":{
            "title":"License Type",
            "maxLength":"100",
            "type":"string",
            "description":"The user-friendly name for the business license type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":"3",
            "type":"string",
            "description":"The currency code used for applying payments.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessEntityKey":{
            "type":"integer",
            "description":"The unique identifier for the business entity.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "UrlLabel":{
            "title":"URL",
            "maxLength":"255",
            "type":"string",
            "description":"Meaningful label for the URL.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LicensePeriod":{
            "title":"License Period",
            "maxLength":"100",
            "type":"string",
            "description":"The period that applies to the business license transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocationAddress":{
            "title":"Address",
            "maxLength":"900",
            "type":"string",
            "description":"Full business location address contains address line 1, address line 2, address Line 3, city, state, and postal code.",
            "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"
            }
        },
        "BusDbaBusinessName":{
            "title":"Doing Business As",
            "maxLength":"100",
            "type":"string",
            "description":"The doing business as name for the business.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessLocationKey":{
            "type":"integer",
            "description":"Unique identifier for the transaction business location.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "IssueDate":{
            "title":"Issue Date",
            "type":"string",
            "description":"The date when the business license application was issued.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RenewalDate":{
            "title":"Renewal Date",
            "type":"string",
            "description":"Indicates the date when an issued business license was renewed.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalFees":{
            "title":"Total Fees",
            "type":"number",
            "description":"The total amount of fees for this  business license record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessLocationId":{
            "title":"Location ID",
            "maxLength":"50",
            "type":"string",
            "description":"Meaningful identifier for the business location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The date when the business license expires.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpirationGraceDate":{
            "title":"Expiration Grace Date",
            "type":"string",
            "description":"Indicates the new date that the business license can be extended.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LicenseStatus":{
            "title":"License Status",
            "maxLength":"30",
            "type":"string",
            "description":"The overall status of the business.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalFeesDue":{
            "title":"Balance Due",
            "type":"number",
            "description":"The amount of fees that are currently due for this business license record.",
            "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