Home → API Documentation → User Dashboard → api/User

8.1. api/User

This API call will return information such as contact information and company information, depending on the call type (calltype). The call requires you to pass the uid of the user logged in, the calltype and updatevalues.

The updatevalues you can pass as an empty string.

Call Types

•    UserProfile – Returns an array of data relating to the individual user.

•    UserCompany – Returns an array of data relating to the individual user’s Company/Organisation.

•    UserBookings – Returns an array of all bookings for this user or where the user made the booking for someone else.

•    Users – Returns an array of other Contacts within the same organisation (will only return data if the user is marked as a Main Contact or Web Admin within Rubi).

•    UserOffers – Returns an array of all offers submitted by the user’s company.

•    UserEvents – Returns an array of all events submitted by the user’s company.

•    UserNews – Returns an array of all news items submitted by the user’s company.

•    UserVacancies – Returns an array of all vacancies submitted by the user’s company.

Parameters To Submit

If the parameters below highlighted with “*” are submitted, they cannot be submitted as blank values.

Parameter	Parameter Help	Parameter Data Type
uid*	Logged in user’s uid.	String – Max 50 chars
CallType*	Call type with available options above.	String – Max 20 chars
UpdateValues	Empty string.	String

 

Return Response

The API call will return different fields of data depending on the call type used.

 

UserProfile

Field	Field Help
uid	Contact’s uid.
ConsentReceived	Whether the user has accepted the client’s Terms and Conditions. Expected to reconsent every 365 days.
Title	Contact’s title.
FirstName	Contact’s first name.
LastName	Contact’s last name.
KnownAs	What the contact is known by.
EmailAddress	Contact’s email address.
JobTitle	Contact’s job title.
MobileCountry	Contact’s mobile country code.
Mobile	Contact’s mobile number.
TelCountry	Contact’s telephone country code.
Tel	Contact’s telephone number.
TelExt	Contact’s telephone extension number.
Address1	First line of the contact’s address.
Address2	Second line of the contact’s address.
Address3	Third line of the contact’s address.
Address4	Fourth line of the contact’s address.
County	County contact lives in.
Postcode	Contact’s postcode.
Country	Country contact lives in.
UserImage	URL of contact’s profile image.
SocialMedia	A JSON array of the contact’s social media.
MarketingPreferences	A JSON array of the contact’s marketing preferences (Contact Interests in Rubi).
CompInd	Whether the contact is a part of a company record or an individual record. Returns “C”, “I” or “U” (unknown).
AdditionalInfo	Additional information if required by the client.

 

UserCompany

Field	Field Help
cid	Company’s cid.
Company	Company’s name.
CompanyTelCountry	Company’s telephone country code.
CompanyTel	Company’s telephone number.
CompanyFax	Company’s fax number.
CompanyEmail	Company’s email address.
CompanyWeb	Company’s website URL.
Category	The business category of the company.
BusinessDescription	The company’s business description.
Address1	First line of the company’s address.
Address2	Second line of the company’s address.
Address3	Third line of the company’s address.
Address4	Fourth line of the company’s address.
County	County the company resides in.
Postcode	Company’s postcode.
Country	Country company resides in.
Contact	One of the main contacts in the company. Decided based on top 1.
Offers	The number of member offers the company has set to display will be returned.
CompanyLogo	URL of the company’s profile image.
SocialMedia	A JSON array of the company’s social media.
[Status]	The company’s membership status.
DateJoined	The company’s membership join date.
DateRenewal	The company’s membership renewal date.
CompanyInterests	A JSON array of the company’s interests.
TradingAs	Company’s trading name.

 

UserBookings

Field	Field Help
ItemGUID	bid.
Item	Returns that the item is a “Booking”.
ItemDetails	The name of the event the booking is associated with.
ItemContact	The contact attending the event the booking is associated with.
ItemValue	The booking price excluding tax.
ItemTax	The booking tax.
ItemTaxRate	The booking tax rate.
ItemTotal	The booking price including tax.
ItemSaving	The saving made on the booking (may be different to default saving of price type).
ItemPotentialSaving	The saving set for the price type.
ItemRateType	Price type used for booking.
ItemInfo1	Special requests made.
ItemInfo2	Booking notes made. Normally for internal purposes for the client.
eid	The event’s eid the booking was made for.
NamedGuestOrg	Named guest organisation (if a named guest was set).
NamedGuestName	Named guest name (if a named guest was set).
NamedGuestEmail	Named guest email (if a named guest was set).
BookingStatus	Status of the booking. Could be “Active”, “Cancelled”, “Attended”, “No Show” etc.
EventDate	Date of the event that the booking is for.

 

Users

Field	Field Help
uid	uid of the user.
FirstName	User’s first name.
LastName	User’s last name.
EmailAddress	User’s email address.
JobTitle	User’s job title.
ContactLeft	Whether the contact has left or not. We do not return users who have left as part of this call.

 

UserOffers

Field	Field Help
oid	oid of the offer.
Category	Category of the offer.
ShortDescription	Title of the offer.
LongDescription	Main body of text about the offer.
StartDate	When the offer should begin showing on the website.
EndDate	When the offer should stop showing on the website.
OfferCode	Offer code.
DateCreated	When the offer was submitted.
CreatedBy	Who the offer was submitted by.
Approved	Whether the client has approved the offer to display on the website.
Removed	If the offer has been deleted.

 

UserEvents

Field	Field Help
mid	mid of the event.
Category	Category of the event.
ShortDescription	Title of the event.
LongDescription	Main body of text about the event.
EventLocation	Location of where the event is taking place.
StartDate	When the event begins.
EndDate	When the event ends.
EventCode	Event code.
DateCreated	When the event was submitted.
CreatedBy	Who the event was submitted by.
Approved	Whether the client has approved the event to display on the website.
Removed	If the event has been deleted.

 

UserNews

Field	Field Help
nid	nid of the news item.
Category	Category of the news item.
ShortDescription	Title of the news item.
LongDescription	Main body of text about the news item.
StartDate	The date the news item should begin showing on the website.
StartTime	The time the news item should begin showing on the website.
EndDate	The date the news item should stop showing on the website.
EndTime	The time the news item should stop showing on the website.
DateCreated	When the news item was submitted.
CreatedBy	Who the news item was submitted by.
Approved	Whether the client has approved the news item to display on the website.
Removed	If the news item has been deleted.

 

UserVacancies

Field	Field Help
vid	vid of the vacancy.
Category	Category of the vacancy.
ShortDescription	Title of the vacancy.
LongDescription	Main body of text about the vacancy.
StartDate	The date the vacancy should begin showing on the website.
EndDate	The date the vacancy should stop showing on the website.
DateCreated	When the vacancy was submitted.
CreatedBy	Who the vacancy was submitted by.
Approved	Whether the client has approved the vacancy to display on the website.
Removed	If the vacancy has been deleted.