GET /JobAgents

Service for getting a list of job agents.

Request Information

URI Parameters

None.

Body Parameters

None.

OData support

Optional query options:
- $top
- $skip
- $filter
- $orderby (fields supported: JobAgentId, JobAgentName, JobAgentCreated, JobAgentLastSent, JobAgentRecepientEmail)

Supported logical operators:
- and
- or
- eq

Supported functions:
- any
- substringof

Query examples

$top, $skip
/JobsAgents/?$top=10&$skip=0

$filter on JobAgentJobCategories (Admin, Secretarial, PA)
/JobsAgents/?$top=10&$skip=0&$filter=substringof(',102,', JobAgentJobCategories)

$filter on JobAgentJobTypes (Part-time)
/JobsAgents/?$top=10&$skip=0&$filter=substringof(',7,', JobAgentJobTypes)

$filter on JobAgentJobLocations (Entire UK)
/JobsAgents/?$top=10&$skip=0&$filter=substringof(',2£UK££££,', JobAgentJobLocations)

$orderby Created (newest first)
/JobsAgents/?$top=10&$skip=0&$orderby=JobAgentCreated desc

$filter on JobAgentJobTypes and JobAgentJobLocations
/JobsAgents/?$top=10&$skip=0&$filter=substringof(',7,', JobAgentJobTypes) and substringof(',2£UK££££,', JobAgentJobLocations)

Response Information

Resource Description

Collection of JobAgent
NameDescriptionTypeAdditional information
JobAgentId

Will be ignored on POST and PUT request

integer

None.

JobAgentName

string

Required

String length: inclusive between 0 and 250

JobAgentSearchText

string

String length: inclusive between 0 and 250

JobAgentJobTypes

string

Matching regular expression pattern: ^,?[0-9]+(,[0-9]+)*,?$

String length: inclusive between 0 and 500

JobAgentJobCategories

string

Matching regular expression pattern: ^,?[0-9]+(,[0-9]+)*,?$

String length: inclusive between 0 and 500

JobAgentJobLocations

string

Matching regular expression pattern: ^(,?)(\d+£\w+£\d*£\d*£\d*£\d*,)*(\d+£\w+£\d*£\d*£\d*£\d*)?$

String length: inclusive between 0 and 1000

JobAgentRecepientEmail

string

Required

String length: inclusive between 0 and 250

JobAgentCreated

Will be ignored on POST and PUT request

date

None.

JobAgentLastSent

Will be ignored on POST and PUT request

date

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "JobAgentId": 56872,
    "JobAgentName": "My job agent",
    "JobAgentSearchText": "personal assistant",
    "JobAgentJobTypes": ",7,8,",
    "JobAgentJobCategories": ",102,",
    "JobAgentJobLocations": ",2£UK£128£98££,2£UK£130£101£812£,",
    "JobAgentRecepientEmail": "email@domain.com",
    "JobAgentCreated": "2013-03-02T12:21:46",
    "JobAgentLastSent": "2013-03-04T01:00:23"
  }
]

application/xml, text/xml

Sample:
<ArrayOfJobAgent xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MatchWork.API.Models">
  <JobAgent>
    <JobAgentCreated>2013-03-02T12:21:46</JobAgentCreated>
    <JobAgentId>56872</JobAgentId>
    <JobAgentJobCategories>,102,</JobAgentJobCategories>
    <JobAgentJobLocations>,2£UK£128£98££,2£UK£130£101£812£,</JobAgentJobLocations>
    <JobAgentJobTypes>,7,8,</JobAgentJobTypes>
    <JobAgentLastSent>2013-03-04T01:00:23</JobAgentLastSent>
    <JobAgentName>My job agent</JobAgentName>
    <JobAgentRecepientEmail>email@domain.com</JobAgentRecepientEmail>
    <JobAgentSearchText>personal assistant</JobAgentSearchText>
  </JobAgent>
</ArrayOfJobAgent>