Company reference
Get company details
Description
Get company details.
Method
URL: https://api.free2convey.co.uk/api/Company/GetCompanyDetails/id
Type: GET
Headers: { Authorization: 'Bearer ' + access_token }
Input parameters
Name | Type | Length | Description | Mandatory |
---|---|---|---|---|
Id | int | Company id | Yes |
Input example
https://api.free2convey.co.uk/api/Company/GetCompanyDetails/1013
Output
Name | Type | Length | Description | Mandatory |
---|---|---|---|---|
CompanyId | int | Company id | Yes | |
Name | string | Company name | Yes | |
Address1 | string | 256 | Address 1 | Yes |
Address2 | string | 256 | Address 2 | No |
Address3 | string | 256 | Address 3 | No |
Town | string | Town | No | |
PostCode | string | 8 | Post code | Yes |
PhoneNo | string | 32 | Phone number | No |
FaxNo | string | 32 | Fax number | No |
EmailAddress | string | 254 | Email address | Yes |
Output example
{
"CompanyId":1013,
"Name":"David & Company",
"Address1":"First Floor, Green House",
"Address2":"hhh",
"Address3":"",
"Town":"London",
"County":"Holborn",
"PostCode":"AA11 1AA",
"PhoneNo":"",
"FaxNo":"",
"EmailAddress":"office@domain.co.uk"
}
Exceptions
Exception type | Exception message |
---|---|
AuthorizationException | Unauthorized access data |
Save company details
Description
Save company details.
Method
URL: https://api.free2convey.co.uk/api/Company/SaveCompanyDetails
Type: POST
Headers: { Authorization: 'Bearer ' + access_token }
Input parameters
Name | Type | Length | Description | Mandatory |
---|---|---|---|---|
CompanyId | int | Company id | Yes | |
Name | string | Company name | Yes | |
Address1 | string | 256 | Address 1 | Yes |
Address2 | string | 256 | Address 2 | No |
Address3 | string | 256 | Address 3 | No |
Town | string | Town | No | |
PostCode | string | 8 | Post code | Yes |
PhoneNo | string | 32 | Phone number | No |
FaxNo | string | 32 | Fax number | No |
EmailAddress | string | 254 | Email address | Yes |
Input example
{
"CompanyId":1013,
"Name":"David & Company",
"Address1":"First Floor, Green House",
"Address2":"address 2",
"Address3":null,
"Town":"London",
"County":"Holborn",
"PostCode":"AA11 1AA",
"PhoneNo":null,
"FaxNo":null,
"EmailAddress":"office@domain.co.uk"
}
Output
On success: true
On error: false
Exceptions
Exception type | Exception message |
---|---|
CompanyNameExistsException | There already exists a company with the same name |
CompanyEmailAddressExistsException | There already exists a company with the same email address |
SaveCompanyDetailsValidationException | Data validation failed: [validation errors] |
AuthorizationException | Unauthorized access data |
Search company
Description
Search a company for registration.
Method
URL: https://api.free2convey.co.uk/api/PortalUser/SearchRegisterCompany
Type: POST
Input parameters
Name | Type | Length | Description | Mandatory |
---|---|---|---|---|
Name | string | Company name | Yes | |
Address1 | string | 256 | Address 1 | No |
Town | string | Town | No | |
PostCode | string | 8 | Post code | No |
EmailAddress | string | 254 | Company email address | No |
Input example
{
"Name":"David*",
"Address1":"",
"Town":"",
"PostCode":"",
"EmailAddress":""
}
Output
Name | Type | Length | Description | Mandatory |
---|---|---|---|---|
CompanyId | int | Company id | Yes | |
Name | string | Company name | Yes | |
Address1 | string | 256 | Address 1 | Yes |
Town | string | Town | No | |
PostCode | string | 8 | Post code | Yes |
EmailAddress | string | 254 | Company email address | Yes |
Output example
[
{
"CompanyId":1013,
"Name":"David & Company",
"Address1":"First Floor, Green House",
"Town":"London",
"PostCode":"AA11 1AA",
"EmailAddress":"office@domain.co.uk"
},
{
"CompanyId":1014,
"Name":"David & Co",
"Address1":"First Floor, Yellow House",
"Town":"London",
"PostCode":"AA22 3AA",
"EmailAddress":"office@company.co.uk"
}
]
Exceptions
Exception type | Exception message |
---|---|
SearchCompanyValidationException | Data validation failed: [validation errors] |