Get all application contact details
get
/fscmRestApi/resources/11.13.18.05/publicSectorApplicationContactTypes
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 the application contact type that matches the specified search criteria.
Finder Variables:- ContactKey; integer; The unique identifier for the contact key.
- ContactTypeName; string; The unique identifier for the contact type name.
- LnpRecordKey; integer; The unique identifier for the record key.
- PrimaryKey: Finds the application contact type that matches the specified search criteria.
-
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:- AgencyId; integer; 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.
- ApplicationAccess; string; Indicates the application access for the contact person.
- Classification; string; The record classification. The classifications can be permit, business license, or planning and zoning.
- ContactAddress1; string; The first address line for the contact person.
- ContactAddress2; string; The second address line for the contact person.
- ContactAltPhone; string; The alternate phone number with country code for the contact person.
- ContactAltPhoneAreaCode; string; The alternate phone area code for the contact person.
- ContactAltPhoneCountryCode; string; The alternate phone country code for the contact person.
- ContactAltPhoneNumber; string; The alternate phone number for the contact person.
- ContactBizPartyId; integer; The contact list business party ID.
- ContactBusinessName; string; The contact business name.
- ContactCity; string; The city for the contact person's address.
- ContactCountry; string; The country for the contact person.
- ContactCounty; string; The county for the contact person's address.
- ContactEmailAddress; string; The email address information for the contact person.
- ContactFirstName; string; The contact first name.
- ContactId; integer; The unique identifier of the contact.
- ContactKey; integer; The unique identifier for the contact.
- ContactLastName; string; The contact last name.
- ContactMiddleName; string; The contact middle name.
- ContactPartyId; integer; The contact list party ID.
- ContactPhoneAreaCode; string; The phone area code for the contact person.
- ContactPhoneCountryCode; string; The phone country code for the contact person.
- ContactPhoneExtension; string; The phone extension for the contact person.
- ContactPhoneNum; string; The phone number for the contact person.
- ContactPhoneNumber; string; The phone number with country code for the contact person.
- ContactPostalCode; string; The postal code for the contact person's address.
- ContactState; string; The state for the contact person's address.
- ContactTypeName; string; The contact type name.
- ContactUserId; string; The contact user ID.
- ContactUserName; string; The contact user name.
- LnpRecordId; string; The identifier for the building permit record. For example, a permit number with a value such as Building Permit ID RA-2017-00029.
- LnpRecordKey; integer; The unique identifier for the record.
- PrimaryFlag; string; Indicates the primary contact in the contact details.
- RecordType; string; The record type. Agencies define the types of permits that they administer, for example, Residential Addition.
- RecordTypeId; string; The unique identifier for the record type.
- Subclassification; string; The subclassification of the type of application.
-
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 TopResponse
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.
Root Schema : publicSectorApplicationContactTypes
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorApplicationContactTypes-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
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. -
ApplicationAccess: string
Read Only:
true
Maximum Length:1
Indicates the application access for the contact person. -
Classification: string
Title:
Classification
Read Only:true
Maximum Length:3
The record classification. The classifications can be permit, business license, or planning and zoning. -
ContactAddress1: string
Read Only:
true
Maximum Length:240
The first address line for the contact person. -
ContactAddress2: string
Read Only:
true
Maximum Length:240
The second address line for the contact person. -
ContactAltPhone: string
Read Only:
true
Maximum Length:60
The alternate phone number with country code for the contact person. -
ContactAltPhoneAreaCode: string
Read Only:
true
Maximum Length:10
The alternate phone area code for the contact person. -
ContactAltPhoneCountryCode: string
Read Only:
true
Maximum Length:10
The alternate phone country code for the contact person. -
ContactAltPhoneNumber: string
Read Only:
true
Maximum Length:40
The alternate phone number for the contact person. -
ContactBizPartyId: integer
(int64)
Read Only:
true
The contact list business party ID. -
ContactBusinessName: string
Read Only:
true
Maximum Length:360
The contact business name. -
ContactCity: string
Read Only:
true
Maximum Length:60
The city for the contact person's address. -
ContactCountry: string
Read Only:
true
Maximum Length:3
The country for the contact person. -
ContactCounty: string
Read Only:
true
Maximum Length:60
The county for the contact person's address. -
ContactEmailAddress: string
Title:
Email
Read Only:true
Maximum Length:320
The email address information for the contact person. -
ContactFirstName: string
Read Only:
true
Maximum Length:150
The contact first name. -
ContactId: integer
(int64)
Read Only:
true
The unique identifier of the contact. -
ContactKey: integer
(int64)
Read Only:
true
The unique identifier for the contact. -
ContactLastName: string
Read Only:
true
Maximum Length:150
The contact last name. -
ContactMiddleName: string
Read Only:
true
Maximum Length:60
The contact middle name. -
ContactPartyId: integer
(int64)
Read Only:
true
The contact list party ID. -
ContactPhoneAreaCode: string
Read Only:
true
Maximum Length:10
The phone area code for the contact person. -
ContactPhoneCountryCode: string
Read Only:
true
Maximum Length:10
The phone country code for the contact person. -
ContactPhoneExtension: string
Read Only:
true
Maximum Length:20
The phone extension for the contact person. -
ContactPhoneNum: string
Read Only:
true
Maximum Length:40
The phone number for the contact person. -
ContactPhoneNumber: string
Title:
Phone
Read Only:true
Maximum Length:60
The phone number with country code for the contact person. -
ContactPostalCode: string
Read Only:
true
Maximum Length:60
The postal code for the contact person's address. -
ContactState: string
Read Only:
true
Maximum Length:60
The state for the contact person's address. -
ContactTypeName: string
Title:
Contact Type
Read Only:true
Maximum Length:120
The contact type name. -
ContactUserId: string
Title:
User ID
Read Only:true
Maximum Length:100
The contact user ID. -
ContactUserName: string
Title:
User Name
Read Only:true
Maximum Length:450
The contact user name. -
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 building permit record. For example, a permit number with a value such as Building Permit ID RA-2017-00029. -
LnpRecordKey: integer
(int64)
Title:
Parent Record Key
Read Only:true
The unique identifier for the record. -
PrimaryFlag: string
Read Only:
true
Maximum Length:1
Indicates the primary contact in the contact details. -
RecordType: string
Title:
Application Type
Read Only:true
Maximum Length:100
The record type. Agencies define the types of permits that they administer, for example, Residential Addition. -
RecordTypeId: string
Title:
Record Type ID
Read Only:true
Maximum Length:30
The unique identifier for the record type. -
Subclassification: string
Title:
Subclassification
Read Only:true
Maximum Length:10
The subclassification of the type of application.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.