GET User/MyProfile/SavedSearch/Get?id={id}

Gets details of a saved search by its unique identifier. The requested information must be associated with the signed in user. Returns the requested SavedSearch object.

Requires Authorization

The endpoint requires a bearer token in the http authorization header. For example "bearer 2YotnFZFEjr1zCsicMWpAA"

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The id of the SavedSearch object being requested.

integer

Required

Body Parameters

None.

Response Information

Resource Description

The SavedSearch object requested if valid and allowed; otherwise HTTP status code 404.

SavedSearch
NameDescriptionTypeAdditional information
Id

Gets or sets the identity.

integer

None.

Name

Gets or sets the name of the saved search.

string

None.

EmailFrequency

Gets or sets the frequency when the email should be sent out.

Frequency

None.

NewNoticesOnly

Gets or sets whether only new notices should be emailed.

boolean

None.

SearchCriteria

Gets or sets the associated with the saved search.

SearchCriteria

None.

Response Formats

application/json, text/json

Sample:
{
  "id": 1,
  "name": "Window cleaning jobs",
  "emailFrequency": "Daily",
  "newNoticesOnly": true,
  "searchCriteria": {
    "types": [
      "Contract",
      "Pipeline"
    ],
    "statuses": [
      "Open"
    ],
    "keyword": "Window cleaning",
    "queryString": null,
    "regions": "Wales,South East",
    "postcode": null,
    "radius": 0.0,
    "valueFrom": 3000.0,
    "valueTo": 20000.0,
    "lastNotifiableUpdateFrom": null,
    "publishedFrom": null,
    "publishedTo": null,
    "deadlineFrom": null,
    "deadlineTo": null,
    "approachMarketFrom": null,
    "approachMarketTo": null,
    "awardedFrom": null,
    "awardedTo": null,
    "isSubcontract": null,
    "suitableForSme": true,
    "suitableForVco": false,
    "cpvCodes": null
  }
}

application/xml, text/xml

Sample:
<SavedSearch xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IPL.ContractsFinder.BusinessEntities">
  <EmailFrequency>Daily</EmailFrequency>
  <Id>1</Id>
  <Name>Window cleaning jobs</Name>
  <NewNoticesOnly>true</NewNoticesOnly>
  <SearchCriteria>
    <ApproachMarketFrom i:nil="true" />
    <ApproachMarketTo i:nil="true" />
    <AwardedFrom i:nil="true" />
    <AwardedTo i:nil="true" />
    <CpvCodes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
    <DeadlineFrom i:nil="true" />
    <DeadlineTo i:nil="true" />
    <IsSubcontract i:nil="true" />
    <Keyword>Window cleaning</Keyword>
    <LastNotifiableUpdateFrom i:nil="true" />
    <Postcode i:nil="true" />
    <PublishedFrom i:nil="true" />
    <PublishedTo i:nil="true" />
    <QueryString i:nil="true" />
    <Radius>0.0</Radius>
    <Regions>Wales,South East</Regions>
    <Statuses>
      <NoticeStatus>Open</NoticeStatus>
    </Statuses>
    <SuitableForSme>true</SuitableForSme>
    <SuitableForVco>false</SuitableForVco>
    <Types>
      <NoticeType>Contract</NoticeType>
      <NoticeType>Pipeline</NoticeType>
    </Types>
    <ValueFrom>3000.0</ValueFrom>
    <ValueTo>20000.0</ValueTo>
  </SearchCriteria>
</SavedSearch>