POST Thirdparty/Organisations

Request Information

URI Parameters

None.

Body Parameters

MYCII_EWS.BusinessObjects.SignUp+SearchForOrg
NameDescriptionTypeAdditional information
SearchText

string

Matching regular expression pattern: ^[a-zA-Z0-9\s.\?\,\'\;\:\!\-]+$

String length: inclusive between 0 and 100
SearchType

string

Matching regular expression pattern: ^[a-zA-Z]+$

String length: inclusive between 0 and 10
Email

string

String length: inclusive between 0 and 100
CompanyName

string

Matching regular expression pattern: ^[a-zA-Z0-9\s.\?\,\'\;\:\!\-]+$

String length: inclusive between 0 and 100

Request Formats

application/json, text/json

Sample: 
{
  "SearchText": "sample string 1",
  "SearchType": "sample string 2",
  "Email": "sample string 3",
  "CompanyName": "sample string 4"
}

application/xml, text/xml

Sample: 
<SearchForOrg xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <SearchText>sample string 1</SearchText>
  <SearchType>sample string 2</SearchType>
  <Email>sample string 3</Email>
  <CompanyName>sample string 4</CompanyName>
</SearchForOrg>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

MYCII_EWS.BusinessObjects.SignUp+Organisations
NameDescriptionTypeAdditional information
OrganisationsList

Collection of MYCII_EWS.BusinessObjects.SignUp+OrganisationList

None.
SearchFor

string

None.
MatchedOrganisations

Collection of MYCII_EWS.BusinessObjects.SignUp+OrganisationList

None.

Response Formats

application/json, text/json

Sample: 
{
  "OrganisationsList": [
    {
      "CompanyName": "sample string 1",
      "MemberType": "sample string 2",
      "MemberId": "sample string 3",
      "OrganisationTypeId": "sample string 4"
    },
    {
      "CompanyName": "sample string 1",
      "MemberType": "sample string 2",
      "MemberId": "sample string 3",
      "OrganisationTypeId": "sample string 4"
    }
  ],
  "SearchFor": "sample string 1",
  "MatchedOrganisations": [
    {
      "CompanyName": "sample string 1",
      "MemberType": "sample string 2",
      "MemberId": "sample string 3",
      "OrganisationTypeId": "sample string 4"
    },
    {
      "CompanyName": "sample string 1",
      "MemberType": "sample string 2",
      "MemberId": "sample string 3",
      "OrganisationTypeId": "sample string 4"
    }
  ]
}

application/xml, text/xml

Sample: 
<Organisations xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <OrganisationsList>
    <OrganisationList>
      <CompanyName>sample string 1</CompanyName>
      <MemberType>sample string 2</MemberType>
      <MemberId>sample string 3</MemberId>
      <OrganisationTypeId>sample string 4</OrganisationTypeId>
    </OrganisationList>
    <OrganisationList>
      <CompanyName>sample string 1</CompanyName>
      <MemberType>sample string 2</MemberType>
      <MemberId>sample string 3</MemberId>
      <OrganisationTypeId>sample string 4</OrganisationTypeId>
    </OrganisationList>
  </OrganisationsList>
  <SearchFor>sample string 1</SearchFor>
  <MatchedOrganisations>
    <OrganisationList>
      <CompanyName>sample string 1</CompanyName>
      <MemberType>sample string 2</MemberType>
      <MemberId>sample string 3</MemberId>
      <OrganisationTypeId>sample string 4</OrganisationTypeId>
    </OrganisationList>
    <OrganisationList>
      <CompanyName>sample string 1</CompanyName>
      <MemberType>sample string 2</MemberType>
      <MemberId>sample string 3</MemberId>
      <OrganisationTypeId>sample string 4</OrganisationTypeId>
    </OrganisationList>
  </MatchedOrganisations>
</Organisations>