Sender data
You have 2 options when it comes to sending the profile details - find the unique sender id of the profile stored in idibu and send that, or send the full user profile details in the post. Refer to the User Management Webservice for more info.
Send the sender id as defined inside idibu
| Required? | Field Name | Data Type | Description |
|---|---|---|---|
| Yes | sender | To get a list of the sender profile in your account including the unique ids use:
https://ws.idibu.com/clients/api/enum.php?enum=Sender&source=mine&hash=[INSERT LOGIN HASH HERE] | Identifies the sender profile to be used with this post |
An example here is: <sender id="31000290" />
Submit all sender info with the post
In this instance all tags must be wrapped in the sender envelope.
| Required? | Field Name | Data Type | Description |
|---|---|---|---|
| No | expiryemails | Values: Yes/No | The system sends out emails alerting users when their job ads expire |
| No | team | A valid team id (see discovery services) | See explanation below of the team id tag |
| No | title | Values: Mr/Mrs/Ms | |
| Yes | name | text | First name of sender |
| Yes | lastname | text | Last name of sender |
| Yes | text | ||
| Yes | company | text | Company name |
| Yes | phone | text | |
| No | fax | text | |
| Yes | www | text | |
| No | address1 | text | |
| No | address2 | text | |
| No | address3 | text | |
| Yes | country | text | |
| Yes | postcode | text |
An example of this is:
<sender>
<!-- below is the list of mandatory fields -->
<name>John</name>
<lastname>Doe</lastname>
<email>john@doe.com</email>
<company>One World Market</company>
<phone>044424345324</phone>
<www>http://some.website.com</www>
<country>UK</country>
<postcode>XXX111</postcode>
<!-- below is the list of non-mandatory fields. -->
<expiryemails>No</expiryemails><title></title>
<address1>Some address</address1>
<address2>Some address2</address2>
<address3>Some address3</address3>
<fax>044424345325</fax>
</sender>
Unless the posting system is tightly integrated into idibu (i.e., all sender ids have been fetched from idibu using the discovery service, and those ids are used when posting) it's advisable to always send the complete sender information, rather than the sender id. Our system will always try to match the name, last name and email to data already in our system before creating a new profile.
Team Tag
You can also send the team id to the sender part of the payload.
In that case, you'll need to add a TEAM tag with an id parameter specifying the team to which to assign the sender:
<sender>
<!-- below is the list of mandatory fields -->
<name>John</name>
<lastname>Doe</lastname>
<team id="10000">
<email>john@doe.com</email>
<!-- rest of the sender profile tags -->
...
</team>
</sender>
The list of teams, offices and its IDs are available in:
https://ws.idibu.com/clients/api/enum.php?enum=Sender&source=mine&hash=[INSERT LOGIN HASH HERE]
A couple of points when sending sender details.
- If the sender already exists in the system, it is possible to send only the name, lastname and email address instead of the sender profile id to identify the sender in the system, albeit this practice isn't advisable as the request will fail if the sender isn't found and not all the required tags are in the payload.
- If you send the team tag the system analyses which profile this sender belongs to. If its different to the current placement, the system updates it.
- Sending a team tag with an id value of 0 (zero) will remove any profile from the team it is in, without affecting the quota assigned directly to that profile.
- All quota assignments are honored after a profiles is created, loaded or if it's team is changed.