Jump to

• Request
• Response

Get a code technician

get

/fscmRestApi/resources/11.13.18.05/publicSectorSearchCodeTechnicians/{publicSectorSearchCodeTechniciansUniqID}

Request

Path Parameters

• publicSectorSearchCodeTechniciansUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Search Code Technicians resource and used to uniquely identify an instance of Search Code Technicians. The client should not generate the hash key value. Instead, the client should query on the Search Code Technicians collection resource in order to navigate to a specific instance of Search Code Technicians to get the hash key.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields 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 fields 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 fields. 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 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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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 Top

Response

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.

Body ()

Root Schema : publicSectorSearchCodeTechnicians-item-response

Type: object

Show Source

• 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.
• 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.
• 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.

{
    "type":"object",
    "properties":{
        "LegalEmployer":{
            "title":"Legal Employer",
            "maxLength":240,
            "type":"string",
            "description":"The legal employer of the code technician.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier of the agency associated with the code technician.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "Manager":{
            "title":"Manager",
            "maxLength":240,
            "type":"string",
            "description":"The manager of the code technician.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "JobTitleId":{
            "title":"Job Title",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the job title associated with the code technician.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplayName":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"The display name of the code technician.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HireDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the code technician was hired.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"string",
            "description":"The switch to indicate that the code technician is active.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessUnitName":{
            "title":"Business Unit",
            "maxLength":240,
            "type":"string",
            "description":"The name of the business unit associated with the code technician.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkerPersonType":{
            "title":"Worker Person Type",
            "maxLength":80,
            "type":"string",
            "description":"The worker type of the code technician.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IsSupervisor":{
            "title":"Is Supervisor",
            "maxLength":1,
            "type":"string",
            "description":"The switch to indicate that the code technician is a supervisor.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonNumber":{
            "title":"Person Number",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the code technician person.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SystemPersonType":{
            "title":"System Person Type",
            "maxLength":30,
            "type":"string",
            "description":"The person type of the code technician.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "JobFuncGrpId":{
            "title":"Job Group",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the job group function associated with the code technician.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ListName":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"The list name of the code technician.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IncidentCount":{
            "title":"Incidents",
            "type":"integer",
            "description":"The number of incidents assigned to the code technician.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UserGuid":{
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier of the code technician user.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "FirstName":{
            "title":"First Name",
            "maxLength":150,
            "type":"string",
            "description":"The first name of the code technician.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessUnitId":{
            "type":"integer",
            "description":"The unique identifier of the business unit of the code technician.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Email",
            "maxLength":240,
            "type":"string",
            "description":"The email address of the code technician.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MangaerPersonNumber":{
            "title":"Person Number",
            "maxLength":30,
            "type":"string",
            "description":"The unique person number of the manager of the code technician.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonId":{
            "type":"integer",
            "description":"The unique identifier of the code technician.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Username":{
            "title":"User Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the user associated with the code technician.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UserId":{
            "type":"integer",
            "description":"The unique identifier of the user associated with the code technician.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssignmentType":{
            "title":"Assignment Type",
            "maxLength":30,
            "type":"string",
            "description":"The assignment type of the code technician.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyAddressId":{
            "title":"Agency Location",
            "type":"integer",
            "description":"The unique identifier of the address of the agency associated with the code technician.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PhoneNumber":{
            "title":"Phone",
            "maxLength":60,
            "type":"string",
            "description":"The phone number of the code technician.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CaseCount":{
            "title":"Cases",
            "type":"integer",
            "description":"The number of cases assigned to the code technician.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastName":{
            "title":"Last Name",
            "maxLength":150,
            "type":"string",
            "description":"The last name of the code technician.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DepartmentId":{
            "title":"Agency Department",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the department associated with the code technician.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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