PUT Api/Synchronize/Company?isValidationOnly={isValidationOnly}&requestTimeoutSeconds={requestTimeoutSeconds}

Create, update and delete Company data of the current mandator. Thus, this is a synchronization interface. The provided inputString (XML) will be validated against the XML Schema for company import. Please use it to generate your XML data. This method can be used to test data ingeration first and integrate data then.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
isValidationOnly

Determine whether to test or to integrate data

boolean

Required

requestTimeoutSeconds

The maximum seconds to complete the request, otherwise it will fail. Example, 3600 seconds = 1 hour

integer

Required

Body Parameters

HTTP body parameters

CompanySynchronizeParameter
NameDescriptionTypeAdditional information
XmlContent

Xml content represented as string. Will be validated with the Company-Import Xml-schema.

string

None.

Request Formats

application/json, text/json

Sample:
{
  "XmlContent": "sample string 1"
}

application/xml, text/xml

Sample:
<CompanySynchronizeParameter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">
  <XmlContent>sample string 1</XmlContent>
</CompanySynchronizeParameter>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Logging information about changes.

CompanySynchronizeResponse
NameDescriptionTypeAdditional information
Result

Result root object

SyncResult

None.

Status

Flag parameter holding status information about the general success.

StatusType

None.

Response Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.