Jump to

• Request
• Response

Get all permit attachment communication items

get

/fscmRestApi/resources/11.13.18.05/publicSectorPermitAttachmentCommunications

Request

Query Parameters

• dependency: string
  This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes 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 attributes 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 attributes. 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 attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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 permit attachment communication item using the specified permit attachment identifiers. Finder Variables:
    • AttachmentId; integer; The unique identifier of the permit attachment.
    • LnpRecordKey; integer; The unique identifier of the application to which the permit attachment belongs.
• 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.
• 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 attributes. 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
• 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".

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourcecollection+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorPermitAttachmentCommunications

Type: object

Show Source

• count(optional): integer
  Title: Count

  The number of resource instances returned in the current range.
• hasMore(optional): boolean
  Title: HasMore

  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(optional): array Items
  Title: Items

  The items in the collection.
• limit(optional): integer
  Title: Limit

  The actual paging size used by the server.
• links(optional): array Items
  Title: Items

  The link relations associated with the resource instance.
• offset(optional): integer
  Title: Offset

  The offset value used in the current page.

{
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range.",
            "title":"Count"
        },
        "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.",
            "title":"HasMore"
        },
        "items":{
            "items":{
                "$ref":"#/definitions/publicSectorPermitAttachmentCommunications-item"
            },
            "type":"array",
            "description":"The items in the collection.",
            "title":"Items"
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server.",
            "title":"Limit"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "title":"Items"
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page.",
            "title":"Offset"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorPermitAttachmentCommunications-item

{
    "items":{
        "$ref":"#/definitions/publicSectorPermitAttachmentCommunications-item"
    },
    "type":"array",
    "description":"The items in the collection.",
    "title":"Items"
}

Nested Schema : Items

Type: array

Title: Items

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : publicSectorPermitAttachmentCommunications-item

Type: object

Show Source

• Address1(optional): string
  Title: Address Line 1

  Maximum Length: 240

  The first or main address.
• Address2(optional): string
  Title: Address Line 2

  Maximum Length: 240

  The second address, if present.
• ApplicantId(optional): integer(int64)
  The party ID of the person applying for a permit.
• ApplicantName(optional): string
  Title: Applicant Name

  Maximum Length: 450

  The name of the applicant.
• AttachmentId(optional): integer(int64)
  The unique identifer for a permit attachment.
• City(optional): string
  Title: City

  Maximum Length: 60

  The city in the parcel address.
• Country(optional): string
  Title: Country

  Maximum Length: 3

  The country in the address.
• County(optional): string
  Title: County

  Maximum Length: 60

  The county in the parcel address.
• CreationDate(optional): string(date-time)
  Title: Uploaded On

  The date and time when the attachment was created.
• DocCategory(optional): string
  Title: Document Category

  Maximum Length: 30

  The value that will be displayed for the document category related to an attachment.
• DocCategoryCode(optional): string
  Maximum Length: 30

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

  Maximum Length: 30

  The value that will be displayed for document subcategory related to an attachment.
• DocSubcategoryCode(optional): string
  Maximum Length: 30

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

  Maximum Length: 100

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

  Maximum Length: 255

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

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

  Maximum Length: 100

  The file type of the attachment, such as PDF or text.
• links(optional): array Items
  Title: Items

  Link Relations
• LnpRecordId(optional): string
  Title: Permit

  Maximum Length: 50

  The permit record identifier.
• LnpRecordKey(optional): integer(int64)
  The unique identifer for a permit.
• PermitDescription(optional): string
  Title: Permit Description

  Maximum Length: 1000

  The permit description.
• PermitStatus(optional): string
  Title: Permit Status

  Maximum Length: 15

  The permit status.
• PermitStatusCode(optional): string
  Maximum Length: 15

  The permit status code.
• PostalCode(optional): string
  Title: Postal Code

  Maximum Length: 60

  The postal code in the parcel address.
• Province(optional): string
  Title: Province

  Maximum Length: 60

  The province in the parcel address.
• RecordType(optional): string
  Title: Permit Type

  Maximum Length: 100

  The user-friendly name for the permit type.
• State(optional): string
  Title: State

  Maximum Length: 60

  The state in the parcel address.

{
    "properties":{
        "Address1":{
            "maxLength":240,
            "type":"string",
            "description":"The first or main address.",
            "title":"Address Line 1"
        },
        "Address2":{
            "maxLength":240,
            "type":"string",
            "description":"The second address, if present.",
            "title":"Address Line 2"
        },
        "ApplicantId":{
            "format":"int64",
            "type":"integer",
            "description":"The party ID of the person applying for a permit."
        },
        "ApplicantName":{
            "maxLength":450,
            "type":"string",
            "description":"The name of the applicant.",
            "title":"Applicant Name"
        },
        "AttachmentId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifer for a permit attachment."
        },
        "City":{
            "maxLength":60,
            "type":"string",
            "description":"The city in the parcel address.",
            "title":"City"
        },
        "Country":{
            "maxLength":3,
            "type":"string",
            "description":"The country in the address.",
            "title":"Country"
        },
        "County":{
            "maxLength":60,
            "type":"string",
            "description":"The county in the parcel address.",
            "title":"County"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the attachment was created.",
            "title":"Uploaded On"
        },
        "DocCategory":{
            "maxLength":30,
            "type":"string",
            "description":"The value that will be displayed for the document category related to an attachment.",
            "title":"Document Category"
        },
        "DocCategoryCode":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the document category."
        },
        "DocSubcategory":{
            "maxLength":30,
            "type":"string",
            "description":"The value that will be displayed for document subcategory related to an attachment.",
            "title":"Document Subcategory"
        },
        "DocSubcategoryCode":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the document subcategory."
        },
        "FileDescription":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the attachment.",
            "title":"File Description"
        },
        "FileName":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the attached file.",
            "title":"File Name"
        },
        "FileSize":{
            "format":"int64",
            "type":"integer",
            "description":"The size of the attached file.",
            "title":"File Size"
        },
        "FileType":{
            "maxLength":100,
            "type":"string",
            "description":"The file type of the attachment, such as PDF or text.",
            "title":"File Type"
        },
        "LnpRecordId":{
            "maxLength":50,
            "type":"string",
            "description":"The permit record identifier.",
            "title":"Permit"
        },
        "LnpRecordKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifer for a permit."
        },
        "PermitDescription":{
            "maxLength":1000,
            "type":"string",
            "description":"The permit description.",
            "title":"Permit Description"
        },
        "PermitStatus":{
            "maxLength":15,
            "type":"string",
            "description":"The permit status.",
            "title":"Permit Status"
        },
        "PermitStatusCode":{
            "maxLength":15,
            "type":"string",
            "description":"The permit status code."
        },
        "PostalCode":{
            "maxLength":60,
            "type":"string",
            "description":"The postal code in the parcel address.",
            "title":"Postal Code"
        },
        "Province":{
            "maxLength":60,
            "type":"string",
            "description":"The province in the parcel address.",
            "title":"Province"
        },
        "RecordType":{
            "maxLength":100,
            "type":"string",
            "description":"The user-friendly name for the permit type.",
            "title":"Permit Type"
        },
        "State":{
            "maxLength":60,
            "type":"string",
            "description":"The state in the parcel address.",
            "title":"State"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

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

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top