Create and Manage Employer Records via the API

Introduction 

This is likely to be useful for customers who would like to integrate Bud with their CRM Systems which already house their client's organisational structure. Bud provides the ability to:

Create Employers

When creating a new employer in Bud, you can provide information pertaining to that employer, its location and employer contacts, that are to be linked.

 

Collection Field Name Nullable Data Type Validation
n/a Id Yes GUID Must be unique
n/a  parentId Yes GUID Must be a valid Employer GUID
n/a ern Yes String Must be 9 characters long
n/a levyPayer Yes Boolean True or False
n/a agreeId Yes String  
n/a name No String  
Location id Yes GUID You can set the GUID of the record. Must be unique
Line1 No String  
Line2 Yes String  
Line3 Yes String  
postTown Yes String  
postcode No String Must match postcode regex
typeOfLocation Yes String  
Contact id Yes GUID You can set the GUID of the record. Must be unique
firstName No String  
lastName No String  
email No String Must match email regex
phone Yes String Must match phone number regex
jobRole No String  

Endpoint POST   /employer

 

Retrieve Employer Information

This allows you to find employers and generate a list of all employer contacts that are linked to it. 

 

Collection Field Name Nullable Data Type
n/a employerId No GUID
n/a employerName No String
Contacts contactId No GUID
firstName No String
lastName No String
Email No String
phone Yes String
jobRole No String

Endpoint GET   /employer

 

Update the address of an employer

This endpoint allows you to keep the addresses of your employers up to date. Passing nothing into the nullable fields will overwrite any data already there.

 

Collection Field Name Nullable Data Type Validation
n/a name No String  
location line1 No String  
Line2 Yes String  
Line3 Yes String  
postTown Yes String  
Postcode No String Must match postcode regex
typeOfLocation Yes String  

Endpoint PATCH   /employer/{employerId}

 

Re-parent an Employer

It is possible to amend the structure of your employer hierarchy using this endpoint, simply providing the GUID of the record to change, and the GUID of the record to set as its parent Employer.

 

Collection Field Name Nullable Data Type Validation
n/a parentId No GUID Must be a valid Employer GUID

Endpoint PUT   /employer/parent/{employerId}

 

Related to

Was this article helpful?

0 out of 0 found this helpful

Have more questions? Submit a request