POST api/organisation/list

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
organisationIds	Collection of globally unique identifier	None.
keyword	string	None.
IsTrainingSiteHospitalRegistrar	boolean	None.
IsTrainingSiteHospitalResident	boolean	None.
IsTrainingCommunityPharmacyResident	boolean	None.
APIEndPoint	string	None.
ParentEntityId	globally unique identifier	None.
pageSize	integer	None.
pageNumber	integer	None.
SortBy	string	None.
SortOrderDescending	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "organisationIds": [
    "6639fc97-e3fd-4f88-b4ec-1c844c1ecb23",
    "bfc24fa5-919b-45e0-9fbc-36c7c837eca3"
  ],
  "keyword": "sample string 1",
  "IsTrainingSiteHospitalRegistrar": true,
  "IsTrainingSiteHospitalResident": true,
  "IsTrainingCommunityPharmacyResident": true,
  "APIEndPoint": "sample string 5",
  "ParentEntityId": "71f02436-af5b-4810-861a-1856cd0f3443",
  "pageSize": 6,
  "pageNumber": 7,
  "SortBy": "sample string 8",
  "SortOrderDescending": true
}

application/xml, text/xml

Sample:

<RequestOrganisationListModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SHPACollegeAPI.Models.RequestModels">
  <APIEndPoint>sample string 5</APIEndPoint>
  <ParentEntityId>71f02436-af5b-4810-861a-1856cd0f3443</ParentEntityId>
  <SortBy>sample string 8</SortBy>
  <SortOrderDescending>true</SortOrderDescending>
  <pageNumber>7</pageNumber>
  <pageSize>6</pageSize>
  <IsTrainingCommunityPharmacyResident>true</IsTrainingCommunityPharmacyResident>
  <IsTrainingSiteHospitalRegistrar>true</IsTrainingSiteHospitalRegistrar>
  <IsTrainingSiteHospitalResident>true</IsTrainingSiteHospitalResident>
  <keyword>sample string 1</keyword>
  <organisationIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>6639fc97-e3fd-4f88-b4ec-1c844c1ecb23</d2p1:guid>
    <d2p1:guid>bfc24fa5-919b-45e0-9fbc-36c7c837eca3</d2p1:guid>
  </organisationIds>
</RequestOrganisationListModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.