Get all code technicians
get
/fscmRestApi/resources/11.13.18.05/publicSectorSearchCodeTechnicians
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:- JobFunctionFinder: Finds code technicians that match the specified criteria.
Finder Variables:- issueSubtypeId; string; The unique identifier of the issue subtype.
- issueTypeId; string; The unique identifier of the issue type.
- value; string; The search value.
- PrimaryKey: Finds the code technician that matches the specified criteria.
Finder Variables:- PersonId; integer; The unique identifier of the code technician.
- JobFunctionFinder: Finds code technicians that match the specified 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:- AgencyAddressId; integer; The unique identifier of the address of the agency associated with the code technician.
- AgencyId; integer; The unique identifier of the agency associated with the code technician.
- AssignmentType; string; The assignment type of the code technician.
- BillRate; number; The bill rate for time recording.
- BillRateFrequency; string; The bill rate frequency for time recording.
- BusinessUnitId; integer; The unique identifier of the business unit of the code technician.
- BusinessUnitName; string; The name of the business unit associated with the code technician.
- CaseCount; integer; The number of cases assigned to the code technician.
- CurrencyCode; string; The bill rate currency code for time recording.
- DepartmentId; string; The unique identifier of the department associated with the code technician.
- DisplayName; string; The display name of the code technician.
- EmailAddress; string; The email address of the code technician.
- EnabledFlag; string; The switch to indicate that the code technician is active.
- FirstName; string; The first name of the code technician.
- HireDate; string; The date when the code technician was hired.
- IncidentCount; integer; The number of incidents assigned to the code technician.
- IsSupervisor; string; The switch to indicate that the code technician is a supervisor.
- JobFuncGrpId; string; The unique identifier of the job group function associated with the code technician.
- JobTitleId; string; The unique identifier of the job title associated with the code technician.
- LastName; string; The last name of the code technician.
- LegalEmployer; string; The legal employer of the code technician.
- ListName; string; The list name of the code technician.
- Manager; string; The manager of the code technician.
- MangaerPersonNumber; string; The unique person number of the manager of the code technician.
- PersonId; integer; The unique identifier of the code technician.
- PersonNumber; string; The unique identifier of the code technician person.
- PhoneNumber; string; The phone number of the code technician.
- SystemPersonType; string; The person type of the code technician.
- UserId; integer; The unique identifier of the user associated with the code technician.
- Username; string; The name of the user associated with the code technician.
- WorkerPersonType; string; The worker type of the code technician.
-
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 : publicSectorSearchCodeTechnicians
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 : publicSectorSearchCodeTechnicians-item-response
Type:
Show Source
object
-
AgencyAddressId: integer
(int64)
Title:
Agency Location
Read Only:true
The unique identifier of the address of the agency associated with the code technician. -
AgencyId: integer
(int32)
Title:
Agency ID
Read Only:true
The unique identifier of the agency associated with the code technician. -
AssignmentType: string
Title:
Assignment Type
Read Only:true
Maximum Length:30
The assignment type of the code technician. -
BillRate: number
Read Only:
true
The bill rate for time recording. -
BillRateFrequency: string
Read Only:
true
Maximum Length:30
The bill rate frequency for time recording. -
BusinessUnitId: integer
(int64)
Read Only:
true
The unique identifier of the business unit of the code technician. -
BusinessUnitName: string
Title:
Business Unit
Read Only:true
Maximum Length:240
The name of the business unit associated with the code technician. -
CaseCount: integer
Title:
Cases
Read Only:true
The number of cases assigned to the code technician. -
CurrencyCode: string
Read Only:
true
Maximum Length:3
The bill rate currency code for time recording. -
DepartmentId: string
Title:
Agency Department
Read Only:true
Maximum Length:30
The unique identifier of the department associated with the code technician. -
DisplayName: string
Title:
Name
Read Only:true
Maximum Length:240
The display name of the code technician. -
EmailAddress: string
Title:
Email
Read Only:true
Maximum Length:240
The email address of the code technician. -
EnabledFlag: string
Title:
Enabled
Read Only:true
Maximum Length:1
The switch to indicate that the code technician is active. -
FirstName: string
Title:
First Name
Read Only:true
Maximum Length:150
The first name of the code technician. -
HireDate: string
(date)
Title:
Start Date
Read Only:true
The date when the code technician was hired. -
IncidentCount: integer
Title:
Incidents
Read Only:true
The number of incidents assigned to the code technician. -
IsSupervisor: string
Title:
Is Supervisor
Read Only:true
Maximum Length:1
The switch to indicate that the code technician is a supervisor. -
JobFuncGrpId: string
Title:
Job Group
Read Only:true
Maximum Length:50
The unique identifier of the job group function associated with the code technician. -
JobTitleId: string
Title:
Job Title
Read Only:true
Maximum Length:50
The unique identifier of the job title associated with the code technician. -
LastName: string
Title:
Last Name
Read Only:true
Maximum Length:150
The last name of the code technician. -
LegalEmployer: string
Title:
Legal Employer
Read Only:true
Maximum Length:240
The legal employer of the code technician. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ListName: string
Title:
Name
Read Only:true
Maximum Length:240
The list name of the code technician. -
Manager: string
Title:
Manager
Read Only:true
Maximum Length:240
The manager of the code technician. -
MangaerPersonNumber: string
Title:
Person Number
Read Only:true
Maximum Length:30
The unique person number of the manager of the code technician. -
PersonId: integer
(int64)
Read Only:
true
The unique identifier of the code technician. -
PersonNumber: string
Title:
Person Number
Read Only:true
Maximum Length:30
The unique identifier of the code technician person. -
PhoneNumber: string
Title:
Phone
Read Only:true
Maximum Length:60
The phone number of the code technician. -
SystemPersonType: string
Title:
System Person Type
Read Only:true
Maximum Length:30
The person type of the code technician. -
UserGuid: string
Read Only:
true
Maximum Length:64
The unique identifier of the code technician user. -
UserId: integer
(int64)
Read Only:
true
The unique identifier of the user associated with the code technician. -
Username: string
Title:
User Name
Read Only:true
Maximum Length:100
The name of the user associated with the code technician. -
WorkerPersonType: string
Title:
Worker Person Type
Read Only:true
Maximum Length:80
The worker type of the code technician.
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.