GET Organisations/Find?Label={Label}&Comment={Comment}&Code={Code}&Archived={Archived}&AddressLine1={AddressLine1}&City={City}&PostCode={PostCode}

Finds all Organisation matching specified criteria.


Parameters

NameDescriptionAdditional information
Label 
Label

Define this parameter in the request URI.
Comment 
Comment

Define this parameter in the request URI.
Code 
Code

Define this parameter in the request URI.
Archived 
Archived

Define this parameter in the request URI.
AddressLine1 
AddressLine1

Define this parameter in the request URI.
City 
City

Define this parameter in the request URI.
PostCode 
PostCode

Define this parameter in the request URI.

Response body formats

A GetOrganisationsResponse containing matching Organisation.

application/json, text/json

Sample: 
{
  "List": [
    {
      "Id": 1,
      "Label": "sample string 2",
      "ParentOrganisationId": 1,
      "Comment": "sample string 3",
      "Code": "sample string 4",
      "PrimaryAddressId": 1,
      "AddressLine1": "sample string 5",
      "City": "sample string 6",
      "PostCode": "sample string 7",
      "OrganisationActionOutcome": 0,
      "Archived": true
    },
    {
      "Id": 1,
      "Label": "sample string 2",
      "ParentOrganisationId": 1,
      "Comment": "sample string 3",
      "Code": "sample string 4",
      "PrimaryAddressId": 1,
      "AddressLine1": "sample string 5",
      "City": "sample string 6",
      "PostCode": "sample string 7",
      "OrganisationActionOutcome": 0,
      "Archived": true
    },
    {
      "Id": 1,
      "Label": "sample string 2",
      "ParentOrganisationId": 1,
      "Comment": "sample string 3",
      "Code": "sample string 4",
      "PrimaryAddressId": 1,
      "AddressLine1": "sample string 5",
      "City": "sample string 6",
      "PostCode": "sample string 7",
      "OrganisationActionOutcome": 0,
      "Archived": true
    }
  ],
  "ResponseInformation": {
    "Errors": [
      {
        "ErrorCode": "sample string 1",
        "Message": "sample string 2"
      },
      {
        "ErrorCode": "sample string 1",
        "Message": "sample string 2"
      },
      {
        "ErrorCode": "sample string 1",
        "Message": "sample string 2"
      }
    ],
    "Status": 0,
    "Links": [
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "IsTemplated": true
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "IsTemplated": true
      }
    ]
  }
}

application/xml, text/xml

Sample: 
<GetOrganisationsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Responses">
  <ResponseInformation xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Common">
    <Errors>
      <ApiErrorDetail>
        <ErrorCode>sample string 1</ErrorCode>
        <Message>sample string 2</Message>
      </ApiErrorDetail>
      <ApiErrorDetail>
        <ErrorCode>sample string 1</ErrorCode>
        <Message>sample string 2</Message>
      </ApiErrorDetail>
      <ApiErrorDetail>
        <ErrorCode>sample string 1</ErrorCode>
        <Message>sample string 2</Message>
      </ApiErrorDetail>
    </Errors>
    <Links>
      <Link>
        <Href>sample string 2</Href>
        <IsTemplated>true</IsTemplated>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
      </Link>
      <Link>
        <Href>sample string 2</Href>
        <IsTemplated>true</IsTemplated>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
      </Link>
      <Link>
        <Href>sample string 2</Href>
        <IsTemplated>true</IsTemplated>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
      </Link>
    </Links>
    <Status>Failure</Status>
  </ResponseInformation>
  <List xmlns:d2p1="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Types" xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Common">
    <d2p1:Organisation>
      <d2p1:Archived>true</d2p1:Archived>
      <d2p1:AddressLine1>sample string 5</d2p1:AddressLine1>
      <d2p1:City>sample string 6</d2p1:City>
      <d2p1:Code>sample string 4</d2p1:Code>
      <d2p1:Comment>sample string 3</d2p1:Comment>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Label>sample string 2</d2p1:Label>
      <d2p1:OrganisationActionOutcome>Success</d2p1:OrganisationActionOutcome>
      <d2p1:ParentOrganisationId>1</d2p1:ParentOrganisationId>
      <d2p1:PostCode>sample string 7</d2p1:PostCode>
      <d2p1:PrimaryAddressId>1</d2p1:PrimaryAddressId>
    </d2p1:Organisation>
    <d2p1:Organisation>
      <d2p1:Archived>true</d2p1:Archived>
      <d2p1:AddressLine1>sample string 5</d2p1:AddressLine1>
      <d2p1:City>sample string 6</d2p1:City>
      <d2p1:Code>sample string 4</d2p1:Code>
      <d2p1:Comment>sample string 3</d2p1:Comment>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Label>sample string 2</d2p1:Label>
      <d2p1:OrganisationActionOutcome>Success</d2p1:OrganisationActionOutcome>
      <d2p1:ParentOrganisationId>1</d2p1:ParentOrganisationId>
      <d2p1:PostCode>sample string 7</d2p1:PostCode>
      <d2p1:PrimaryAddressId>1</d2p1:PrimaryAddressId>
    </d2p1:Organisation>
    <d2p1:Organisation>
      <d2p1:Archived>true</d2p1:Archived>
      <d2p1:AddressLine1>sample string 5</d2p1:AddressLine1>
      <d2p1:City>sample string 6</d2p1:City>
      <d2p1:Code>sample string 4</d2p1:Code>
      <d2p1:Comment>sample string 3</d2p1:Comment>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Label>sample string 2</d2p1:Label>
      <d2p1:OrganisationActionOutcome>Success</d2p1:OrganisationActionOutcome>
      <d2p1:ParentOrganisationId>1</d2p1:ParentOrganisationId>
      <d2p1:PostCode>sample string 7</d2p1:PostCode>
      <d2p1:PrimaryAddressId>1</d2p1:PrimaryAddressId>
    </d2p1:Organisation>
  </List>
</GetOrganisationsResponse>
URI parameters
=
Headers | Add header
: Delete
Body
Samples:
Status
Headers
Body