Add Organisation

Add a new organisation to Collaborate

This API call is used to add a new organisation object to the system.

HTTP Request

POST   /api/4/organisations

Example

POST   http://example.com/context/api/4/organisations

XML format request

<organisation>
	<name>HighQ</name>
	<orgindustryid>359</orgindustryid>
	<internal></internal>
	<status>Active</status>
	<strategic></strategic>
	<externalid></externalid>
	<companyswitchboard></companyswitchboard>
	<onlineserviceslink></onlineserviceslink>
	<activateautologin>true</activateautologin>
	<guid>23</guid>
	<category>145</category>
	<excludesynchronization></excludesynchronization>
	<url>http://highq.com</url>
	<logoid></logoid>
	<logowidth></logowidth>
	<logoheight></logoheight>
	<homepage>451</homepage>
	<disableeditprofile></disableeditprofile>
	<restrictdirectlogin></restrictdirectlogin>

	<contact>
		<name></name>
		<email></email>
		<typeid></typeid>
		<contacttier></contacttier>
	</contact>

	<keycontacts>
		<keycontact>
			<userid></userid>
		</keycontact>
		<keycontact>
			<userid></userid>
		</keycontact>
<!-- upto maximum 10 will be handled -->
	</keycontacts>
</organisation>

JSON format request

{
    "name": "HighQ",
    "orgindustryid": "359",
    "internal": "1",
    "status": "Active",
    "strategic": "1",
    "externalid": "ext_123",
    "companyswitchboard": "abc",
    "onlineserviceslink": "service link",
    "activateautologin": "true",
    "guid": "23",
    "category": "145",
    "excludesynchronization": "1",
    "url": "http://highq.com",
    "logoid": "123",
    "logowidth": "123",
    "logoheight": "123",
    "homepage": "451",
    "disableeditprofile": "1",
    "restrictdirectlogin": "1",
    "contact": {
      "name": "Saviz Izadpanah",
      "email": "saviz.izadpanah@highq.com",
      "typeid": "13",
      "contacttier": "1"
    },
    "keycontacts": {
      "keycontact": [
        {
          "userid": "23"
        },
        {
          "userid": "24"
        }
      ]
    }
}

HTTP Response

Success

HTTP response 201 with organisation summary object 

Error

See  API Error messages 

XML response

<organisation>
    <orgid>13</orgid>
    <name>qwe</name>
    <link>http://example.com/context/api/4/organisations/13</link>
</organisation>

JSON response

{
    "name": "HighQ",
    "link": "http://example.com/context/api/4/organisations/12",
    "orgid": "12"
}

Error messages