Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
titleHTTP response - body parameters
{
    StatusType Status,
    SyncResult Result
}
Code Block
titleType definitions
linenumberstrue
enum StatusType 
{
    ValidData = 1,
    InValidData = 2,
    PeristingSkiped = 4,
    PersistingError = 8,
    PersistingSuccess = 16,
}
 
SyncResult
{
    string Identifyer,
    string Type,
    Message[] Messages,
    SyncResult[] NestedResults
}
 
Message
{
    string Text,
    Severity Severity
}
 
enum Severity
{
    Trace,
    Debug,
    Info,
    Warning,
    Error
}

The type definitions can also be found on github https://github.com/eRecruiter/eRecruiter.Api/blob/master/eRecruiter.Api/Responses/Synchronize/CompanySynchronizeResponse.cs. GitHub.

XML Schema

View file
nameCompanyImport.xsd
height250

...

The import operation is an Update update operation too. For each data element in the XML, the importer tries to find an already existing similar data record in the eRecruiter database. If a data record is found, the attributes are updated with the values of the data element in the import XML. If no existing data record is found, a new data record is created. The following list describes which entities are identified by which what property.

Company

A company entity is identified by the ExternalId property. If the existing data record matches the ExternalId of the import element, all values in the import element are stored to the existing data record.

...

  • DocumentTypeName
  • FileName
  • FileExtension

It's just possible to change update the file content of the document.

...

A contact's phone is identified by it's its PhoneNumber. It will be either updated or created.

...

A contact's email is identified by it's its EmailAdress. It will be either updated or created.

...

Code Block
titleusage of company import
--RunCompanySynchronization --XmlCompanySource PATH/TO/IMPORT.xml --ApiKey THE123API456KEY789 --ApiUrl "http://URL.TO/Api" --MandatorId ID --RequestTimeout 3600

The server and client side timeout was is set to 1 hour, on the client side the timeout of the parameter RequestTimeout (in seconds) can be used to set the timeout. It's recommended to use the timeout parameter, due to a time consuming data synchronization operation.