Administration
Click here for a complete list of operations.
OrganisationAndUserAdd
Sep 2018. Provides a mechanism to create a new organisation and user at the same time.
Please note sParentOrganisationIdentifier is required to indicate placement in the tree (either a valid numeric OrganisationID or string OrganisationIdentifier).
The newly created organisation is returned or null if failed.
Test
The test form is only available for requests from the local machine.SOAP 1.1
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
POST /JSON/Administration.asmx/OrganisationAndUserAdd HTTP/1.1
Host: api.logicmelon.com
Content-Type: application/json; charset=utf-8
Content-Length: length
{
"Request": {
"sCultureID": "string",
"sAPIKey": "string",
"sUsername": "string",
"sPassword": "string",
"sParentOrganisationIdentifier": "string",
"Organisation": [
"SchemaIdentifier": "string",
"OrganisationID": int,
"ParentOrganisationID": int,
"OrganisationIdentifier": "string",
"OrganisationName": "string",
"OrganisationTZID": "short",
"OrganisationCultureID": "string",
"Address1": "string",
"Address2": "string",
"Address3": "string",
"State": "string",
"Country": "string",
"PostCode": "string",
"MainContactName": "string",
"MainContactPhone": "string",
"MainContactFax": "string",
"MainContactEmail": "string",
"WebSite": "string",
"OrganisationLogoURL": "string"
},
"User": [
"UserID": int,
"OrganisationID": int,
"UserIdentifier": "string",
"FirstName": "string",
"LastName": "string",
"Phone": "string",
"Email": {string",
"ApplicationsEmail": "string",
"Fax": "string",
"Username": "string",
"Password": "string",
"UserRoleID": int,
"UserCultureID": "string",
"WebSite": "string",
"UserAddress1": "string",
"UserAddress2": "string",
"UserAddress3": "string",
"UserState": "string",
"UserCountry": "string",
"UserPostCode": "string",
"UserWebSite": "string",
"Mobile": "string",
"Position": "string",
"BBDCopySentMessages": boolean,
"BBDLiveAdvertEmail": boolean,
"BBDExpiringEmail": boolean,
"BBDExpiredEmail": boolean,
"DailyNewCandidatesEmail": boolean,
"BBDInformCandidatesEmail": boolean,
"BBDRemovedManuallyEmail": boolean
},
"sBoolAdvancedDontUpdateCache": "string"
}
}
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: length
{ "d": [ or {
"Organisation": [
"SchemaIdentifier": "string",
"OrganisationID": int,
"ParentOrganisationID": int,
"OrganisationIdentifier": "string",
"OrganisationName": "string",
"OrganisationTZID": "short",
"OrganisationCultureID": "string",
"Address1": "string",
"Address2": "string",
"Address3": "string",
"State": "string",
"Country": "string",
"PostCode": "string",
"MainContactName": "string",
"MainContactPhone": "string",
"MainContactFax": "string",
"MainContactEmail": "string",
"WebSite": "string",
"OrganisationLogoURL": "string"
},
"User": [
"UserID": int,
"OrganisationID": int,
"UserIdentifier": "string",
"FirstName": "string",
"LastName": "string",
"Phone": "string",
"Email": {string",
"ApplicationsEmail": "string",
"Fax": "string",
"Username": "string",
"Password": "string",
"UserRoleID": int,
"UserCultureID": "string",
"WebSite": "string",
"UserAddress1": "string",
"UserAddress2": "string",
"UserAddress3": "string",
"UserState": "string",
"UserCountry": "string",
"UserPostCode": "string",
"UserWebSite": "string",
"Mobile": "string",
"Position": "string",
"BBDCopySentMessages": boolean,
"BBDLiveAdvertEmail": boolean,
"BBDExpiringEmail": boolean,
"BBDExpiredEmail": boolean,
"DailyNewCandidatesEmail": boolean,
"BBDInformCandidatesEmail": boolean,
"BBDRemovedManuallyEmail": boolean
}
]
}
SOAP 1.2
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
POST /JSON/Administration.asmx/OrganisationAndUserAdd HTTP/1.1
Host: api.logicmelon.com
Content-Type: application/json; charset=utf-8
Content-Length: length
{
"Request": {
"sCultureID": "string",
"sAPIKey": "string",
"sUsername": "string",
"sPassword": "string",
"sParentOrganisationIdentifier": "string",
"Organisation": [
"SchemaIdentifier": "string",
"OrganisationID": int,
"ParentOrganisationID": int,
"OrganisationIdentifier": "string",
"OrganisationName": "string",
"OrganisationTZID": "short",
"OrganisationCultureID": "string",
"Address1": "string",
"Address2": "string",
"Address3": "string",
"State": "string",
"Country": "string",
"PostCode": "string",
"MainContactName": "string",
"MainContactPhone": "string",
"MainContactFax": "string",
"MainContactEmail": "string",
"WebSite": "string",
"OrganisationLogoURL": "string"
},
"User": [
"UserID": int,
"OrganisationID": int,
"UserIdentifier": "string",
"FirstName": "string",
"LastName": "string",
"Phone": "string",
"Email": {string",
"ApplicationsEmail": "string",
"Fax": "string",
"Username": "string",
"Password": "string",
"UserRoleID": int,
"UserCultureID": "string",
"WebSite": "string",
"UserAddress1": "string",
"UserAddress2": "string",
"UserAddress3": "string",
"UserState": "string",
"UserCountry": "string",
"UserPostCode": "string",
"UserWebSite": "string",
"Mobile": "string",
"Position": "string",
"BBDCopySentMessages": boolean,
"BBDLiveAdvertEmail": boolean,
"BBDExpiringEmail": boolean,
"BBDExpiredEmail": boolean,
"DailyNewCandidatesEmail": boolean,
"BBDInformCandidatesEmail": boolean,
"BBDRemovedManuallyEmail": boolean
},
"sBoolAdvancedDontUpdateCache": "string"
}
}
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: length
{ "d": [ or {
"Organisation": [
"SchemaIdentifier": "string",
"OrganisationID": int,
"ParentOrganisationID": int,
"OrganisationIdentifier": "string",
"OrganisationName": "string",
"OrganisationTZID": "short",
"OrganisationCultureID": "string",
"Address1": "string",
"Address2": "string",
"Address3": "string",
"State": "string",
"Country": "string",
"PostCode": "string",
"MainContactName": "string",
"MainContactPhone": "string",
"MainContactFax": "string",
"MainContactEmail": "string",
"WebSite": "string",
"OrganisationLogoURL": "string"
},
"User": [
"UserID": int,
"OrganisationID": int,
"UserIdentifier": "string",
"FirstName": "string",
"LastName": "string",
"Phone": "string",
"Email": {string",
"ApplicationsEmail": "string",
"Fax": "string",
"Username": "string",
"Password": "string",
"UserRoleID": int,
"UserCultureID": "string",
"WebSite": "string",
"UserAddress1": "string",
"UserAddress2": "string",
"UserAddress3": "string",
"UserState": "string",
"UserCountry": "string",
"UserPostCode": "string",
"UserWebSite": "string",
"Mobile": "string",
"Position": "string",
"BBDCopySentMessages": boolean,
"BBDLiveAdvertEmail": boolean,
"BBDExpiringEmail": boolean,
"BBDExpiredEmail": boolean,
"DailyNewCandidatesEmail": boolean,
"BBDInformCandidatesEmail": boolean,
"BBDRemovedManuallyEmail": boolean
}
]
}