Jump to

• Request
• Response

Get all permit required document communication items

get

/fscmRestApi/resources/11.13.18.05/publicSectorPermitRequiredDocumentCommunications

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

  • Address1; string; The first address line of the permit site.
  • Address2; string; The second address line of the permit site.
  • ApplicantName; string; The name of the applicant of the permit.
  • ApplicationStep; string; The application step of the required documents.
  • City; string; The city in the address of the permit site.
  • Country; string; The country in the address of the permit site.
  • County; string; The county in the address of the permit site.
  • LnpRecordId; string; The permit identifier. For example, a permit ID with a value such as RA-2017-00029.
  • LnpRecordKey; integer; The unique identifier for a permit.
  • PermitDescription; string; The description of the permit.
  • PermitStatus; string; The status of the permit.
  • PermitStatusDescription; string; The status description of the permit.
  • PermitSystemStatus; string; The status code of the permit.
  • PostalCode; string; The postal code in the address of the permit site.
  • RecordType; string; The permit type.
  • RecordTypeId; string; The permit type code.
  • ReqDocCatSubcatDescrList; string; The list of the document category and subcategory descriptions of the required documents.
  • ReqDocCatSubcatList; string; The list of document categories and subcategories of the required documents.
  • State; string; The state in the address of the permit site.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

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

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

Root Schema : publicSectorPermitRequiredDocumentCommunications

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":{
        "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."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/publicSectorPermitRequiredDocumentCommunications-item-response"
            }
        },
        "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"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    },
    "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 publicSectorPermitRequiredDocumentCommunications-item-response

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

Type: object

Show Source

• Address1: string
  Title: Address Line 1

  Read Only: true

  Maximum Length: 240

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

  Read Only: true

  Maximum Length: 240

  The second address line of the permit site.
• ApplicantName: string
  Title: Applicant Name

  Read Only: true

  Maximum Length: 450

  The name of the applicant of the permit.
• ApplicationStep: string
  Title: Application Step

  Read Only: true

  Maximum Length: 255

  The application step of the required documents.
• City: string
  Title: City

  Read Only: true

  Maximum Length: 60

  The city in the address of the permit site.
• Country: string
  Title: Country

  Read Only: true

  Maximum Length: 3

  The country in the address of the permit site.
• County: string
  Title: County

  Read Only: true

  Maximum Length: 60

  The county in the address of the permit site.
• 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 permit identifier. For example, a permit ID with a value such as RA-2017-00029.
• LnpRecordKey: integer
  Read Only: true

  The unique identifier for a permit.
• PermitDescription: string
  Title: Application Description

  Read Only: true

  Maximum Length: 1000

  The description of the permit.
• PermitStatus: string
  Title: Application Status

  Read Only: true

  Maximum Length: 15

  The status of the permit.
• PermitStatusDescription: string
  Title: Application Status Description

  Read Only: true

  Maximum Length: 100

  The status description of the permit.
• PermitSystemStatus: string
  Read Only: true

  Maximum Length: 15

  The status code of the permit.
• PostalCode: string
  Title: Postal Code

  Read Only: true

  Maximum Length: 60

  The postal code in the address of the permit site.
• RecordType: string
  Title: Application Type

  Read Only: true

  Maximum Length: 100

  The permit type.
• RecordTypeId: string
  Read Only: true

  Maximum Length: 30

  The permit type code.
• ReqDocCatSubcatDescrList: string
  Title: Required Document Category and Subcategory Pair Description List

  Read Only: true

  Maximum Length: 255

  The list of the document category and subcategory descriptions of the required documents.
• ReqDocCatSubcatList: string
  Title: Required Document Category and Subcategory Pair List

  Read Only: true

  Maximum Length: 255

  The list of document categories and subcategories of the required documents.
• State: string
  Title: State

  Read Only: true

  Maximum Length: 60

  The state in the address of the permit site.

{
    "type":"object",
    "properties":{
        "Address1":{
            "title":"Address Line 1",
            "maxLength":240,
            "type":"string",
            "description":"The first address line of the permit site.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Address2":{
            "title":"Address Line 2",
            "maxLength":240,
            "type":"string",
            "description":"The second address line of the permit site.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicantName":{
            "title":"Applicant Name",
            "maxLength":450,
            "type":"string",
            "description":"The name of the applicant of the permit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicationStep":{
            "title":"Application Step",
            "maxLength":255,
            "type":"string",
            "description":"The application step of the required documents.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "City":{
            "title":"City",
            "maxLength":60,
            "type":"string",
            "description":"The city in the address of the permit site.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":3,
            "type":"string",
            "description":"The country in the address of the permit site.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "County":{
            "title":"County",
            "maxLength":60,
            "type":"string",
            "description":"The county in the address of the permit site.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordId":{
            "title":"Application ID",
            "maxLength":50,
            "type":"string",
            "description":"The permit identifier. For example, a permit ID with a value such as RA-2017-00029.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"The unique identifier for a permit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PermitDescription":{
            "title":"Application Description",
            "maxLength":1000,
            "type":"string",
            "description":"The description of the permit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PermitStatus":{
            "title":"Application Status",
            "maxLength":15,
            "type":"string",
            "description":"The status of the permit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PermitStatusDescription":{
            "title":"Application Status Description",
            "maxLength":100,
            "type":"string",
            "description":"The status description of the permit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PermitSystemStatus":{
            "maxLength":15,
            "type":"string",
            "description":"The status code of the permit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"The postal code in the address of the permit site.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordType":{
            "title":"Application Type",
            "maxLength":100,
            "type":"string",
            "description":"The permit type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordTypeId":{
            "maxLength":30,
            "type":"string",
            "description":"The permit type code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReqDocCatSubcatDescrList":{
            "title":"Required Document Category and Subcategory Pair Description List",
            "maxLength":255,
            "type":"string",
            "description":"The list of the document category and subcategory descriptions of the required documents.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReqDocCatSubcatList":{
            "title":"Required Document Category and Subcategory Pair List",
            "maxLength":255,
            "type":"string",
            "description":"The list of document categories and subcategories of the required documents.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "State":{
            "title":"State",
            "maxLength":60,
            "type":"string",
            "description":"The state in the address of the permit site.",
            "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"
            }
        }
    }
}

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