Home → API Documentation → Custom API Calls → api/AwardsApplication

12.2. api/AwardsApplication

This API call is used to supply all award application values to create a new record.

 

Parameters To Submit

Parameter	Parameter Help	Parameter Data Type
application	JSONString stringified array of parameters. Review parameters below.	String
API Key

 

 

---

 

application

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

Parameter	Parameter Help	Parameter Data Type
Company*	Company’s name.	String – Max 250 chars
CompanyTel	Company’s telephone.	String – Max 30 chars
CompanyEmail	Company’s email address.	String – Max 250 chars
Category*	The value passed to the API must be ListValue (Text Value not ID).	String – Provide ListValue from api/PortalList “BusinessCategory”.
BusinessDescription	Company's business description.	String
Employees	Number of employees at the company. If an empty string will default to 1.	Integer
BusinessStatus	The value passed to the API must be ListValue (Text Value not ID).	String – Provide ListValue from api/PortalList “BusinessStatus”.
DateEstablished	Date the company was established.	Date - Provided in the format yyyy-mm-dd
CompanyAddress1*	First line of company’s address.	String – Max 75 chars
CompanyAddress2	Second line of company’s address.	String – Max 75 chars
CompanyAddress3	Third line of company’s address.	String – Max 75 chars
CompanyAddress4*	Fourth line of company’s address.	String – Max 75 chars
CompanyCounty*	The value passed to the API must be ListValue (Text Value not ID). Submit a default value of “None” if no selection is made.	String – Provide ListValue from api/PortalList “County”.
CompanyPostcode*	Postcode of company’s address.	String – Max 15 chars
CompanyCountry*	The value passed to the API must be ListValue (Text Value not ID). Submit a default value of “None” if no selection is made.	String – Provide ListValue from api/PortalList “Country”.
MainContactFirstName*	Main contact completing the application’s first name.	String – Max 100 chars
MainContactLastName*	Main contact completing the application’s last name.	String – Max 100 chars
MainContactEmail*	Main contact completing the application’s email address.	String – Max 200 chars
MainContactJobTitle*	Main contact completing the application’s job title.	String – Max 200 chars
TopExecutiveContactFirstName	The top executive contact's first name at the applying company. Complete all fields if the contact is different from the main contact.	String – Max 100 chars
TopExecutiveContactLastName	The top executive contact's last name at the applying company. Complete all fields if the contact is different from the main contact.	String – Max 100 chars
TopExecutiveContactEmail	The top executive contact's email address at the applying company. Complete all fields if the contact is different from the main contact.	String – Max 200 chars
TopExecutiveContactJobTitle	The top executive contact's job title at the applying company. Complete all fields if the contact is different from the main contact.	String – Max 200 chars

 

---

 

Return Response

The API call ResponseMessage will return a range of fields. The following fields of data will be relevant for your purposes.

Field	Field Help
uid	Contact’s new uid that has just been created.
EmailAddress	Contact’s email address.
FirstName	Contact’s first name.