Get all contact persons
get
/fscmRestApi/resources/11.13.18.05/publicSectorContactLists
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:- ContactListFinder: Finds the contact person that matches the specified filter values.
Finder Variables:- value; string; The filter values to be applied when finding a contact person. Filter fields include Person Name, Email, Address and Phone.
- PrimaryKey: Finds the contact person that matches the primary keys specified.
Finder Variables:- ContactId; integer; The unique identifier for a contact person.
- ContactListFinder: Finds the contact person that matches the specified filter values.
-
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 for the contact person.
- Address2; string; The second address line for the contact person.
- Address3; string; The third address line for the contact person.
- Address4; string; The fourth address line for the contact person.
- AddressFull; string; The formatted address of the contact person.
- City; string; The city for the contact person's address.
- ContactId; integer; The unique identifier for a contact person.
- Country; string; The country for the contact person.
- County; string; The county for the contact person's address.
- CreatedBy; string; The user who created the contact person.
- CreationDate; string; The date and time that the contact person was created.
- EmailAddress; string; The email address information for the contact person.
- JobTitle; string; The business job title of the contact.
- LastUpdateDate; string; The date and time when the contact person was last updated.
- LastUpdatedBy; string; The user who last updated the contact person.
- OrganizationName; string; The name of the business that the contact person is associated with.
- PersonFirstName; string; The contact person's first name.
- PersonFullName; string; The full name of the contact person.
- PersonLastName; string; The contact person's last name.
- PersonMiddleName; string; The contact person's middle name.
- PhoneAreaCode; string; The phone area code of the contact person.
- PhoneCountryCode; string; The phone country code of the contact person.
- PhoneExtension; string; The phone extension for the contact person.
- PhoneFull; string; The formatted phone number of the contact person.
- PhoneNumber; string; The phone number of the contact person.
- PostalCode; string; The postal code of the contact person's address.
- PostalPlus4Code; string; The postal plus-four value for the contact person's address.
- ProfileId; integer; The unique identifier for a registered public user profile.
- Province; string; The province of the contact person's address.
- State; string; The state of the contact person's address.
-
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 : publicSectorContactLists
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 : publicSectorContactLists-item-response
Type:
Show Source
object
-
Address1: string
Maximum Length:
240
The first address line for the contact person. -
Address2: string
Maximum Length:
240
The second address line for the contact person. -
Address3: string
Maximum Length:
240
The third address line for the contact person. -
Address4: string
Maximum Length:
240
The fourth address line for the contact person. -
AddressFull: string
Read Only:
true
The formatted address of the contact person. -
City: string
Maximum Length:
60
The city for the contact person's address. -
ContactId: integer
(int64)
The unique identifier for a contact person.
-
Country: string
Maximum Length:
3
The country for the contact person. -
County: string
Maximum Length:
60
The county for the contact person's address. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the contact person. -
CreationDate: string
(date-time)
Read Only:
true
The date and time that the contact person was created. -
EmailAddress: string
Title:
Email
Maximum Length:320
The email address information for the contact person. -
JobTitle: string
Maximum Length:
60
The business job title of the contact. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the contact person was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the contact person. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationName: string
Title:
Business
Maximum Length:360
The name of the business that the contact person is associated with. -
PersonFirstName: string
Title:
First Name
Maximum Length:150
The contact person's first name. -
PersonFullName: string
Read Only:
true
The full name of the contact person. -
PersonLastName: string
Title:
Last Name
Maximum Length:150
The contact person's last name. -
PersonMiddleName: string
Title:
Middle Name
Maximum Length:60
The contact person's middle name. -
PhoneAreaCode: string
Maximum Length:
10
The phone area code of the contact person. -
PhoneCountryCode: string
Maximum Length:
10
The phone country code of the contact person. -
PhoneExtension: string
Maximum Length:
20
The phone extension for the contact person. -
PhoneFull: string
Read Only:
true
The formatted phone number of the contact person. -
PhoneNumber: string
Maximum Length:
40
The phone number of the contact person. -
PostalCode: string
Maximum Length:
60
The postal code of the contact person's address. -
PostalPlus4Code: string
Maximum Length:
60
The postal plus-four value for the contact person's address. -
ProfileId: integer
(int64)
The unique identifier for a registered public user profile.
-
Province: string
Maximum Length:
60
The province of the contact person's address. -
State: string
Maximum Length:
60
The state of the contact person's address.
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.