Find

Returns XML containing a list of assignments matching the search parameters of the request. Only assignments published by the authenticated user's company will be listed.

End point

/api/DistributionApi/Find

Request format

GET

Request content

The following parameters can be specified as query string values of the request:

Property Name Required Description 
id
 No

The ID of the assignment. If this is specified, all other search parameters will be ignored

 
startdate
 No

Earliest publication start date

 
enddate
 No

Latest publication end date

 
phrase
 No

Matches assignments by title or role

 
status
 No

0 (default) – All assignments

1 – Only currently published assignments

2 – Only assignments not currently published

Response Messages

The method will return an XML containing all matching assignments, following this XSD:

<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified"
           xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="Requisitions">
  <xs:complexType>
    <xs:sequence>
      <xs:element name="Requisition" maxOccurs="unbounded" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element type="xs:string" name="Title"/>
            <xs:element type="xs:integer" name="Id"/>
            <xs:element type="xs:dateTime" nillable="true" name="AssignmentStartDate"/>
            <xs:element type="xs:dateTime" nillable="true" name="AssignmentEndDate"/>
            <xs:element type="xs:dateTime" nillable="true" name="PublicationStartDate"/>
            <xs:element type="xs:dateTime" nillable="true" name="PublicationEndDateDate"/>
            <xs:element type="xs:integer" name="CompetenceAreaId"/>
            <xs:element type="xs:string" name="CompetenceArea"/>
            <xs:element type="xs:decimal" name="Extent"/>
            <xs:element type="xs:short" name="ExtentType"/>
            <xs:element type="xs:integer" name="CountryId"/>
            <xs:element type="xs:string" name="Country"/>
            <xs:element type="xs:integer" name="RegionId"/>
            <xs:element type="xs:string" name="Region"/>
            <xs:element type="xs:string" name="Location"/>
            <xs:element type="xs:string" name="MasterLevel"/>
            <xs:element type="xs:string" name="Role"/>
            <xs:element type="xs:string" name="Text"/>
            <xs:element type="xs:string" name="ApplicationEmail"/>
            <xs:element type="xs:boolean" name="NoDelay"/>
            <xs:element type="xs:string" name="ReferenceNumber"/>
            <xs:element type="xs:string" name="ExternalUrl"/>
            <xs:element type="xs:integer" name="OpenApplications"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>
    </xs:sequence>
  </xs:complexType>
</xs:element>
</xs:schema>

Example Request

/api/DistributionApi/Find?senderkey=123&authkey=abc&phrase=java&status=1

This will return all currently published assignments containing the word “java” in the title or role.

Example Response

<Requisitions>
  <Requisition>
    <Title>Java Developer</Title>
    <Id>3679</Id>
    <AssignmentStartDate>2017-11-08T12:00:00</AssignmentStartDate>
    <AssignmentEndDate/>
    <PublicationStartDate>2017-06-27T08:33:47</PublicationStartDate>
    <PublicationEndDateDate>2017-12-06T11:59:59</PublicationEndDateDate>
    <CompetenceAreaId>2</CompetenceAreaId>
    <CompetenceArea>Management & Strategy</CompetenceArea>
    <Extent>25.00</Extent>
    <ExtentType>1</ExtentType>
    <CountryId>76</CountryId>
    <Country>United Kingdom</Country>
    <RegionId>0</RegionId>
    <Region/>
    <Location/>
    <MasterLevel>High</MasterLevel>
    <Role>some role</Role>
    <Text>Lorem Ipsum</Text>
    <ApplicationEmail>abc123</ApplicationEmail>
    <NoDelay>false</NoDelay>
    <ReferenceNumber></ReferenceNumber>
    <ExternalUrl></ExternalUrl>
    <OpenApplications>4</OpenApplications>
  </Requisition>
</Requisitions>

OpenApplications in the XML above contains the number specifies the number of applications made for the assignment that has not yet been accepted or rejected.