Inquiry
This reference page will give you all public API details for retrieving, inserting, updating and deleting inquiries in RecMan.
GET method details
Get is the method for retrieving data for inquiries.
| URL Get | https://api.recman.no/v2/get/ |
| Scope | inquiry |
| Page | Pagenumber, 100 inquiries per page |
| Example | https://api.recman.no/v2/get/index.php?scope=inquiry&key=KEY&page=1&archived=0 |
| archived | optional, see description below. |
Click here if you want to try out our API tester
View JSON example
{
"success": true,
"numRows": 1,
"data": {
"18373": {
"inquiryId": 18373,
"inquiryNumber": 1,
"name": "Please contact me",
"body": "This is just a sample of the inquiry text",
"created": "2018-07-18 15:25:39",
"updated": "2018-07-18 15:26:13",
"deadline": "2018-07-31 20:00:00",
"inquiryStatusId": 0,
"inquiryTypeId": 0,
"read": 1,
"archived": 0,
"userIds": [
"5328"
]
}
}
}archived is optional. Value 0 will only list inquiries that are not archived. archived = 1 will ONLY list archived inquiries.
POST method details
The POST method is used for inserting, updating and deleting inquiries. More information on each operation can be found in the sidebar menu.
| URL POST | https://api.recman.no/v2/post/ |
| Scope | inquiry |
| Operation | insert / update / delete |
| Fields | See details below |
Fields
| Fields | Description |
|---|---|
| inquiryIdinteger |
Required on operation: update delete |
| namestring | Name of Inquiry |
| bodystring | The inquiry, body text |
| contactstring | See details below |
| userIdsarray of integer | List of user Ids |
| companyIdsarray of integer | List of company Ids |
| companyContactIdsarray of integer | List of company contact Ids |
| candidateIdsarray of integer | List of candidate Ids |
| projectIdsarray of integer | List of projectIds |
| inquiryStatusIdinteger | Inquiry Status Id |
| inquiryTypeIdstring | Inquiry Type Id |
| inquiryTagIdsarray of integer | Inquiry Tag Ids |
Inquiry Contact
| Field |
|---|
| contactobject |
| Sub Fields | Description |
|---|---|
| inquiryIdstring | Inquiry ID |
| companyNamestring | Company name |
| vatNumberstring | VAT number |
| namestring | Name |
| officePhonestring | Office phone |
| mobilePhonestring | Mobile phone |
| emailstring |
Inquiry Settings
To list settings from inquiries in RecMan, like tags, inquiry type and status you can use the scope inquirySettings.
This will list the needed ID’s to insert inquiry with the right tags, type and status. You can alter and edit inquiry settings in RecMan in the top left corner of the inquiry page:
The settings looks like this:
| GET URL | https://api.recman.no/v2/get/ |
| Scope | inquirySettings |
| Example | https://api.recman.no/v2/get/index.php?scope=inquirySettings&key=KEY |
{
"inquiryTags": {
"numRows": 2,
"data": [
{
"inquiryTagId": "310",
"name": "Customers"
},
{
"inquiryTagId": "311",
"name": "Noncustomer"
}
]
},
"inquiryStatus": {
"numRows": 2,
"data": [
{
"inquiryStatusId": "136",
"name": "New"
},
{
"inquiryStatusId": "137",
"name": "Solved"
}
]
},
"inquiryTypes": {
"numRows": 2,
"data": [
{
"inquiryTypeId": "128",
"name": "Inquiry"
},
{
"inquiryTypeId": "129",
"name": "Request"
}
]
}
}