Jump to

• Request
• Response

Get all business license attachment communications items

get

/fscmRestApi/resources/11.13.18.05/publicSectorBlAttachmentCommunications

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 business license attachment communication item using the specified identifiers.
    Finder Variables:
    • AttachmentId; integer; The unique identifier for an attachment.
    • LnpRecordKey; integer; The unique identifier for a business license.
• 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:
  

  • ActivityDescription; string; The business license application description.
  • ActivityStatus; string; The status of the business license activity.
  • ActivitySystemStatus; string; The predefined system status to which the activity status maps.
  • Address1; string; The first address line of the business license inspection site.
  • Address2; string; The second address line of the business license inspection site.
  • ApplicantId; integer; The party ID of the person applying for a business license.
  • ApplicantName; string; The business license applicant name.
  • AttachmentCreationDate; string; The date and time when the attachment was created.
  • AttachmentId; integer; The unique identifier for a business license attachment.
  • BusBusinessLegalName; string; The name of the applicant's business. For example, a contractor enters their contracting business name.
  • BusDbaBusinessName; string; A field in the business information component of the form designer used to describe the business name, which is different than the legal business name.
  • City; string; The city in the address of the business license inspection site.
  • ConfidentialFlag; string; Indicates whether the attachment is a confidential document. The default value is N for no.
  • Country; string; The country in the address of the business license inspection site.
  • County; string; The county in the address of the business license inspection site.
  • DocCategory; string; The category used for dividing the attached document into a logical group.
  • DocCategoryCode; string; The unique identifier for the document category.
  • DocSubcategory; string; The subcategory used for dividing the attached document into a logical group along with the category.
  • DocSubcategoryCode; string; The unique identifier for the document subcategory.
  • FileDescription; string; The description of the attachment.
  • FileName; string; The name of the attached file.
  • FileSize; integer; The size of the attached file.
  • FileType; string; The file type of attachment, such as PDF or text.
  • LicenseStatus; string; The status of the license application.
  • LnpRecordId; string; The business license record identifier. For example, a license ID with a value such as License ID RA-2017-00029.
  • LnpRecordKey; integer; The unique identifier for a business license record.
  • Originator; string; The originator of the business license application. For example, AGT for agent.
  • PostalCode; string; The postal code in the address of the business license inspection site.
  • Province; string; The province in the address of the business license inspection site.
  • RecordType; string; The user-friendly name for the business license application type.
  • State; string; The state in the address of the business license inspection site.
  • Subclassification; string; The subclassification of the application record.
  • Url; string; The business license inspection URL used within a communications template.
  • VersionType; string; The version of the business license. Values are original, amendment, and renewal.
• 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:
  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:
  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 : publicSectorBlAttachmentCommunications

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/publicSectorBlAttachmentCommunications-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"SharedServices",
        "usage":"BusinessObject",
        "group":"psc"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorBlAttachmentCommunications-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/publicSectorBlAttachmentCommunications-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 : publicSectorBlAttachmentCommunications-item-response

Type: object

Show Source

• ActivityDescription: string
  Title: Activity Description

  Read Only: true

  Maximum Length: 1000

  The business license application description.
• ActivityStatus: string
  Title: Activity Status

  Read Only: true

  Maximum Length: 15

  The status of the business license activity.
• ActivitySystemStatus: string
  Title: Activity System Status

  Read Only: true

  Maximum Length: 15

  The predefined system status to which the activity status maps.
• Address1: string
  Title: Address Line 1

  Read Only: true

  Maximum Length: 240

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

  Read Only: true

  Maximum Length: 240

  The second address line of the business license inspection site.
• ApplicantId: integer (int64)
  Read Only: true

  The party ID of the person applying for a business license.
• ApplicantName: string
  Title: Applicant Name

  Read Only: true

  Maximum Length: 450

  The business license applicant name.
• AttachmentCreationDate: string (date-time)
  Title: Uploaded On

  Read Only: true

  The date and time when the attachment was created.
• AttachmentId: integer (int64)
  Read Only: true

  The unique identifier for a business license attachment.
• BusBusinessLegalName: string
  Title: Business Legal Name

  Read Only: true

  Maximum Length: 240

  The name of the applicant's business. For example, a contractor enters their contracting business name.
• BusDbaBusinessName: string
  Title: Doing Business As

  Read Only: true

  Maximum Length: 100

  A field in the business information component of the form designer used to describe the business name, which is different than the legal business name.
• City: string
  Title: City

  Read Only: true

  Maximum Length: 60

  The city in the address of the business license inspection site.
• ConfidentialFlag: string
  Read Only: true

  Maximum Length: 1

  Indicates whether the attachment is a confidential document. The default value is N for no.
• Country: string
  Title: Country

  Read Only: true

  Maximum Length: 3

  The country in the address of the business license inspection site.
• County: string
  Title: County

  Read Only: true

  Maximum Length: 60

  The county in the address of the business license inspection site.
• DocCategory: string
  Title: Document Category

  Read Only: true

  Maximum Length: 25

  The category used for dividing the attached document into a logical group.
• DocCategoryCode: string
  Read Only: true

  Maximum Length: 30

  The unique identifier for the document category.
• DocSubcategory: string
  Title: Document Subcategory

  Read Only: true

  Maximum Length: 25

  The subcategory used for dividing the attached document into a logical group along with the category.
• DocSubcategoryCode: string
  Read Only: true

  Maximum Length: 30

  The unique identifier for the document subcategory.
• FileDescription: string
  Title: File Description

  Read Only: true

  Maximum Length: 100

  The description of the attachment.
• FileName: string
  Title: File Name

  Read Only: true

  Maximum Length: 255

  The name of the attached file.
• FileSize: integer (int64)
  Title: File Size

  Read Only: true

  The size of the attached file.
• FileType: string
  Title: File Type

  Read Only: true

  Maximum Length: 100

  The file type of attachment, such as PDF or text.
• LicenseStatus: string
  Title: License Status

  Read Only: true

  Maximum Length: 30

  The status of the license application.
• links: array Links
  Title: Links

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

  Read Only: true

  Maximum Length: 50

  The business license record identifier. For example, a license ID with a value such as License ID RA-2017-00029.
• LnpRecordKey: integer
  Read Only: true

  The unique identifier for a business license record.
• Originator: string
  Title: Originator

  Read Only: true

  Maximum Length: 3

  The originator of the business license application. For example, AGT for agent.
• PostalCode: string
  Title: Postal Code

  Read Only: true

  Maximum Length: 60

  The postal code in the address of the business license inspection site.
• Province: string
  Title: Province

  Read Only: true

  Maximum Length: 60

  The province in the address of the business license inspection site.
• RecordType: string
  Title: License Type

  Read Only: true

  Maximum Length: 100

  The user-friendly name for the business license application type.
• State: string
  Title: State

  Read Only: true

  Maximum Length: 60

  The state in the address of the business license inspection site.
• Subclassification: string
  Title: Subclassification

  Read Only: true

  Maximum Length: 10

  The subclassification of the application record.
• Url: string
  Title: Link to Business License Activity

  Read Only: true

  Maximum Length: 255

  The business license inspection URL used within a communications template.
• VersionType: string
  Title: Version Type

  Read Only: true

  Maximum Length: 1

  The version of the business license. Values are original, amendment, and renewal.

{
    "type":"object",
    "properties":{
        "Subclassification":{
            "title":"Subclassification",
            "maxLength":"10",
            "type":"string",
            "description":"The subclassification of the application record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ConfidentialFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the attachment is a confidential document. The default value is N for no.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActivityStatus":{
            "title":"Activity Status",
            "maxLength":"15",
            "type":"string",
            "description":"The status of the business license activity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActivityDescription":{
            "title":"Activity Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The business license application description.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"255",
            "type":"string",
            "description":"The name of the attached file.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"The postal code in the address of the business license inspection site.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DocCategoryCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier for the document category.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DocSubcategoryCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier for the document subcategory.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "County":{
            "title":"County",
            "maxLength":"60",
            "type":"string",
            "description":"The county in the address of the business license inspection site.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Url":{
            "title":"Link to Business License Activity",
            "maxLength":"255",
            "type":"string",
            "description":"The business license inspection URL used within a communications template.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "URL":"Y"
            },
            "x-queryable":true
        },
        "RecordType":{
            "title":"License Type",
            "maxLength":"100",
            "type":"string",
            "description":"The user-friendly name for the business license application type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Originator":{
            "title":"Originator",
            "maxLength":"3",
            "type":"string",
            "description":"The originator of the business license application. For example, AGT for agent.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantId":{
            "type":"integer",
            "description":"The party ID of the person applying for a business license.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DocCategory":{
            "title":"Document Category",
            "maxLength":"25",
            "type":"string",
            "description":"The category used for dividing the attached document into a logical group.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DocSubcategory":{
            "title":"Document Subcategory",
            "maxLength":"25",
            "type":"string",
            "description":"The subcategory used for dividing the attached document into a logical group along with the category.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordId":{
            "title":"License ID",
            "maxLength":"50",
            "type":"string",
            "description":"The business license record identifier. For example, a license ID with a value such as License ID RA-2017-00029.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusBusinessLegalName":{
            "title":"Business Legal Name",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the applicant's business. For example, a contractor enters their contracting business name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusDbaBusinessName":{
            "title":"Doing Business As",
            "maxLength":"100",
            "type":"string",
            "description":"A field in the business information component of the form designer used to describe the business name, which is different than the legal business name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantName":{
            "title":"Applicant Name",
            "maxLength":"450",
            "type":"string",
            "description":"The business license applicant name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address2":{
            "title":"Address Line 2",
            "maxLength":"240",
            "type":"string",
            "description":"The second address line of the business license inspection site.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AttachmentCreationDate":{
            "title":"Uploaded On",
            "type":"string",
            "description":"The date and time when the attachment was created.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address1":{
            "title":"Address Line 1",
            "maxLength":"240",
            "type":"string",
            "description":"The first address line of the business license inspection site.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "City":{
            "title":"City",
            "maxLength":"60",
            "type":"string",
            "description":"The city in the address of the business license inspection site.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"The unique identifier for a business license record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Province":{
            "title":"Province",
            "maxLength":"60",
            "type":"string",
            "description":"The province in the address of the business license inspection site.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AttachmentId":{
            "type":"integer",
            "description":"The unique identifier for a business license attachment.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "VersionType":{
            "title":"Version Type",
            "maxLength":"1",
            "type":"string",
            "description":"The version of the business license. Values are original, amendment, and renewal.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FileDescription":{
            "title":"File Description",
            "maxLength":"100",
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FileType":{
            "title":"File Type",
            "maxLength":"100",
            "type":"string",
            "description":"The file type of attachment, such as PDF or text.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "State":{
            "title":"State",
            "maxLength":"60",
            "type":"string",
            "description":"The state in the address of the business license inspection site.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LicenseStatus":{
            "title":"License Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the license application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":"3",
            "type":"string",
            "description":"The country in the address of the business license inspection site.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActivitySystemStatus":{
            "title":"Activity System Status",
            "maxLength":"15",
            "type":"string",
            "description":"The predefined system status to which the activity status maps.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FileSize":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attached file.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "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