Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

This web service retrieves a list of skill summary records (PwsSkillSummaryElement), based on specified search criteria. The following parameters affect the list of lists skills retrieved:

  • QueryString: Searches within skill group name and skill name. Any skill containing this string in the skill name, or that is part of a skill group whose name contains this string is included.
  • IncludeInactiveFlag: If false, inactive skills are excluded from the results.
  • SkillGroupIdentity: If specified, only skills in the specified skill group are included. Note QueryString and IncludeInactiveFlag are ignored if SkillGroupIdentity is specified.
  • SkillIdentity: If specified, only the specified skill is included. Note QueryString and IncludeInactiveFlag are ignored if SkillIdentity is specified.

...

Element

Data Type

Required?

Default

Description

Sample Data

RequestId

Int32

No


Click here for more information.


SessionTicket

String

Yes


Click here for more information.


IncludeInactiveFlag

Boolean

No

flase

If set to 'true', skills that are set to inactive will be included in the results. Otherwise, only skills that are considered active will be included.

true

MaxRowsToReturn

Int32

No


The maximum number of skills to be retrieved. This value is disregarded if a skill is specified in SkillIdentity.

10

QueryString

String

No


Find all skills matching specified string in skill's name.

Database

SkillGroupIdentity

PwsSkillGroupRef

No


If specified, return all skills in the specified group.


SkillIdentity

PwsSkillRef

No


If specified, return only the specified skill.


...

Element

Data Type

Description

Messages

PwsMessage[]

The web service response status and message. Click here for more information

ResponseId

Int32

Click here for more information.

Status

RequestStatus

Click here for more information

ServerTimestampUtc

DateTime

Click here for more information.

Skills

PwsSkillSummaryElement[]

This contains the basic set of information about each of the returned skills. 


Response Usage Example(s)

...