Chain reference

Get chains
Description
Return all chains for the logged user
Method
URL: https://api.free2convey.co.uk/api/ChainEntryList/SearchChain
Type: POST
Headers: { Authorization: 'Bearer ' + access_token }
Input parameters
Name Type Size Description Mandatory
ChainEntryDescription string 500 Chain entry description No
ClientName string 256 Client name No
ClientNumberRef string 128 Client number ref No
FeeEarnerId string 128 Fee earner id No
Input example
{ 
   "ChainEntryDescription":null,
   "ClientName":null,
   "ClientNumberRef":null,
   "FeeEarnerId":null
}
Output
Output example
Name Description
Id Chain id
ChainId Chain id
EntryStatusId Entry status id
ChainStatusId Chain status
CompanyId Company id
CompanyName Company name
IsFirstTransaction First transaction
IsLastTransaction Last transaction
IsSaleAndPurchase Sale and purchase
IsMultiplePropertySale Multiple property sale
Position Chain entry position
Description Chain entry description
ClientName Client name
ClientNumberRef Client number ref
FeeEarnerId Chain entry fee earner
ChainEntryComment chain entry comment
FeeEarnerFullName Fee earner full name
BuyPropertyId Buy property id
BuyPropertyDescription Buy property description
SellPropertyId Sell property id
SellPropertyDescription Sell property description
Chain Chain
StatusImage Status image
Status Status
TransactionDescription Transaction description
IsLoggedInUserOwner Logged in user owner
Chain status
Key Value
1 Active
2 Completed
Status (chain entry status)
Key Value
1 Contract negotiations
2 Ready to exchange
3 Exchanged
4 Ready to complete
5 Completed
6 Waiting solicitors update record
7 Solicitors not known 
[
   {
      "Id":26,
      "ChainId":13,
      "EntryStatusId":6,
      "ChainStatusId":1,
      "CompanyId":7,
      "CompanyName":"company 3",
      "IsFirstTransaction":false,
      "IsLastTransaction":false,
      "IsSaleAndPurchase":false,
      "IsMultiplePropertySale":false,
      "Position":1,
      "Description":"caz 3",
      "ClientName":"mid",
      "ClientNumberRef":"",
      "FeeEarnerId":"85394e6c-c76f-4259-901a-be3fbf52352d",
      "FeeEarner":"fee.earner@domain.co.uk",
      "ChainEntryComment":"",
      "FeeEarnerFullName":"doi admin",
      "BuyPropertyId":null,
      "BuyPropertyDescription":null,
      "SellPropertyId":17,
      "SellPropertyDescription":"b2  s2 AA1 1AA",
      "Chain":null,
      "StatusImage":"WaitingSolicitorsUpdateRecord.png",
      "Status":"Waiting solicitors to update record",
      "TransactionDescription":"",
      "IsLoggedInUserOwner":false,
      "ObjectState":0
   }
]
Get chain entry details
Description
Return details for a chain entry
Method
URL: https://api.free2convey.co.uk/api/ChainEntryList/GetChainEntryListByChainId/id
Type: GET
Headers: { Authorization: 'Bearer ' + access_token }
Input parameters
Name Type Size Description Mandatory
Id int Chain id Yes
Input example
https://api.free2convey.co.uk/api/ChainEntryList/GetChainEntryListByChainId/131
Output
Name Description
Id Chain id
ChainStatusId Chain status id
Entries Return all chains involve in selected chain
Id Chain entrie id
ChainId Chain id
EntryStatusId Entry status id
ChainStatusId Chain status id
CompanyId Company id
CompanyName Company name
IsFirstTransaction First transaction
IsLastTransaction Last transaction
IsSaleAndPurchase Sale and purchase
IsMultiplePropertySale Multiple property sale
Position Position
Description Description
ClientName Client name
ClientNumberRef Client number ref
FeeEarnerId Fee earner id
FeeEarner Fee earner email
ChainEntryComment Chain entry comment
FeeEarnerFullName Fee earner full name
BuyPropertyId Buy property id
BuyPropertyDescription Buy property description
SellPropertyId Sell property id
SellPropertyDescription Sell property description
Chain Chain
StatusImage Status image
Status Status
TransactionDescription Transaction description
IsLoggedInUserOwner Logged in user owner
SelectedChainEntryId Selected chain entry id
SelectedChainEntryDescription Selected chain entry description
SelectedChainId Selected chain id
IsLastTransactionSelected Last transaction selected
IsFirstTransactionSelected First transaction selected
AreAllEntriesCompleted Return true if all entries are completed
IsCircleChain Return true if is a circle
TopEntry Return current entry who is on top
BottomEntry Return current entry who is on botton
CanRemoveFirmAbove Return true if we can remove firm above
CanRemoveFirmBellow Return true if we can remove firm bellow
CanRemoveFirm Return true if we can remove my firm
CanUpdateStatus Retrun true if we can update status
Chain status
Key Value
1 Active
2 Completed
Status (chain entry status)
Key Value
1 Contract negotiations
2 Ready to exchange
3 Exchanged
4 Ready to complete
5 Completed
6 Waiting solicitors update record
7 Solicitors not known
Output example
{ 
   "Id":0,
   "ChainStatusId":0,
   "Entries":[ 
      { 
         "Id":131,
         "ChainId":53,
         "EntryStatusId":1,
         "ChainStatusId":1,
         "CompanyId":2,
         "CompanyName":"Moeliss & Company",
         "IsFirstTransaction":true,
         "IsLastTransaction":false,
         "IsSaleAndPurchase":false,
         "IsMultiplePropertySale":false,
         "Position":0,
         "Description":"Purchas property",
         "ClientName":"Admin",
         "ClientNumberRef":"Admin",
         "FeeEarnerId":"7705146b-9a69-4f16-ab36-dad86fb6a4e3",
         "FeeEarner":"fee.earner@domain.co.uk",
         "ChainEntryComment":"",
         "FeeEarnerFullName":"vali vali",
         "BuyPropertyId":111,
         "BuyPropertyDescription":" 27 FLAKE AVENUE EX56 4HY",
         "SellPropertyId":null,
         "SellPropertyDescription":null,
         "Chain":null,
         "StatusImage":"ContractNegotiations.png",
         "Status":"Contract negotiations",
         "TransactionDescription":"First transaction",
         "IsLoggedInUserOwner":true,
         "ObjectState":0
      }
   ],
   "SelectedChainEntryId":131,
   "SelectedChainEntryDescription":"Purchas property",
   "SelectedChainId":53,
   "IsLastTransactionSelected":false,
   "IsFirstTransactionSelected":true,
   "AreAllEntriesCompleted":false,
   "IsCircleChain":false,
   "TopEntry":{ 
      "Id":131,
      "ChainId":53,
      "EntryStatusId":1,
      "ChainStatusId":1,
      "CompanyId":2,
      "CompanyName":"Moeliss & Company",
      "IsFirstTransaction":true,
      "IsLastTransaction":false,
      "IsSaleAndPurchase":false,
      "IsMultiplePropertySale":false,
      "Position":0,
      "Description":"Purchas property",
      "ClientName":"Admin",
      "ClientNumberRef":"Admin",
      "FeeEarnerId":"7705146b-9a69-4f16-ab36-dad86fb6a4e3",
      "FeeEarner":"fee.earner@domain.co.uk",
      "ChainEntryComment":"",
      "FeeEarnerFullName":"John Smith",
      "BuyPropertyId":111,
      "BuyPropertyDescription":" 27 FLAKE AVENUE EX56 4HY",
      "SellPropertyId":null,
      "SellPropertyDescription":null,
      "Chain":null,
      "StatusImage":"ContractNegotiations.png",
      "Status":"Contract negotiations",
      "TransactionDescription":"First transaction",
      "IsLoggedInUserOwner":true,
      "ObjectState":0
   },
   "BottomEntry":{ 
      "Id":131,
      "ChainId":53,
      "EntryStatusId":1,
      "ChainStatusId":1,
      "CompanyId":2,
      "CompanyName":"Moeliss & Company",
      "IsFirstTransaction":true,
      "IsLastTransaction":false,
      "IsSaleAndPurchase":false,
      "IsMultiplePropertySale":false,
      "Position":0,
      "Description":"Purchas property",
      "ClientName":"Admin",
      "ClientNumberRef":"Admin",
      "FeeEarnerId":"7705146b-9a69-4f16-ab36-dad86fb6a4e3",
      "FeeEarner":"fee.earner@domain.co.uk",
      "ChainEntryComment":"",
      "FeeEarnerFullName":"John Smith",
      "BuyPropertyId":111,
      "BuyPropertyDescription":" 27 FLAKE AVENUE EX56 4HY",
      "SellPropertyId":null,
      "SellPropertyDescription":null,
      "Chain":null,
      "StatusImage":"ContractNegotiations.png",
      "Status":"Contract negotiations",
      "TransactionDescription":"First transaction",
      "IsLoggedInUserOwner":true,
      "ObjectState":0
   },
   "CanRemoveFirmAbove":false,
   "CanRemoveFirmBellow":false,
   "CanRemoveFirm":true,
   "CanUpdateStatus":true,
   "ObjectState":0
}
Update chain entry
Description
Update chain details by chain id.
Method
URL: https://api.free2convey.co.uk/api/ChainEntryList/UpdateChainEntry
Type: POST
Headers: { Authorization: 'Bearer ' + access_token }
Input parameters
Name Type Size Description Mandatory
ChainEntryId int Chain entry id No
Description string 500 Description No
ClientName string 256 Client name No
ClientNumberRef string 128 Client number ref No
FeeEarnerId string 128 Fee earner id No
Input example
{ 
   "ChainEntryId":123,
   "Description":"Buy",
   "ClientName":"Firm Zoe",
   "ClientNumberRef":"HC100",
   "FeeEarnerId":"7705146b-9a69-4f16-ab36-dad86fb6a4e3"
}
Output
On success: true
On error: false
Check chain subscription
Description
Check if one chain is subscribed to notification.
Method
URL: https://api.free2convey.co.uk/api/ChainViewEntry/GetChainSubscription/id
Type: Get
Headers: { Authorization: 'Bearer ' + access_token }
Input parameters
Name Type Size Description Mandatory
Id int Chain id Yes
Input example
https://api.free2convey.co.uk/api/ChainViewEntry/GetChainSubscription/53
Output
On success: true
On error: false
Update subscribe to notification
Description
Update subscribe to notification.
Method
URL: https://api.free2convey.co.uk/api/ChainEntryList/InsertUpdateChainNotification
Type: POST
Headers: { Authorization: 'Bearer ' + access_token }
Input parameters
Name Type Size Description Mandatory
ChainId int Chain id Yes
UserId string 128 User id Yes
IsSubscribed bool 256 Tick to subscribe to notification Yes
Input example
{ 
   "ChainId":52,
   "UserId":"7705146b-9a69-4f16-ab36-dad86fb6a4e3",
   "IsSubscribed":true
}
Output
On success: true
On error: false
Exceptions
Exception type Exception message
DataValidationException Data validation failed: [validation errors]
Update chain entry status
Description
Update chain view entry status.
Method
URL: https://api.free2convey.co.uk/api/ChainViewEntry/UpdateChainViewEntryStatus
Type: POST
Headers: { Authorization: 'Bearer ' + access_token }
Input parameters
Name Type Size Description Mandatory
ChainEntryId int Chain entry id Yes
ChainEntryStatusId int Chain entry status id Yes
Chain entry status
Key Value
1 Contract negotiations
2 Ready to exchange
3 Exchanged
4 Ready to complete
5 Completed
6 Waiting solicitors update record
7 Solicitors not known
Input example
{ 
   "ChainEntryId":123,
   "ChainEntryStatusId":6
}
Output
On success: true
On error: false
Exceptions
Exception type Exception message
DataValidationException Data validation failed: [validation errors]
ChainEntryUpdateStatusInvalidValueException The chain entry status cannot be updated by a non-guest user with 'Title Registered' value.
ChainEntryCannotUpdateStatusOnCompletedChainException The chain entry status cannot be updated because the chain is completed.
ChainEntryGuestUpdateStatusInvalidValueException The chain entry status can be updated by a guest user only with 'Title Registered' value.
ChainEntryGuestCannotUpateStatusOnNotCompletedChainException The chain entry status cannot be updated by a guest user when the chain is not completed.
Save/update chain comment
Description
Save or update chain entry comment.
Method
URL: https://api.free2convey.co.uk/api/ChainViewEntry/SaveChainEntryComment
Type: POST
Headers: { Authorization: 'Bearer ' + access_token }
Input parameters
Name Type Size Description Mandatory
Id int Chain entry id Yes
ChainEntryComment string 500 Chain entry comment No
Input example
{ 
   "Id":123,
   "ChainEntryComment":"change comment"
}
Output
On success: true
On error: false
Exceptions
Exception type Exception message
DataValidationException Data validation failed: [validation errors]
Set first firm
Description
Set first firm in chain.
Method
URL: https://api.free2convey.co.uk/api/ChainEntryList/SetFirstFirmInChain/id
Type: GET
Headers: { Authorization: 'Bearer ' + access_token }
Input parameters
Name Type Size Description Mandatory
Id int Chain entry id Yes
Input example
https://api.free2convey.co.uk/api/ChainEntryList/SetFirstFirmInChain/53
Output
On success: true
On error: false
Exceptions
Exception type Exception message
ChainNoLongerExistException Current chain entry no longer exists
Set last firm
Description
Set last firm in chain.
Method
URL: https://api.free2convey.co.uk/api/ChainEntryList/SetLastFirmInChain/id
Type: GET
Headers: { Authorization: 'Bearer ' + access_token }
Input parameters
Name Type Size Description Mandatory
Id int Chain entry id Yes
Input example
https://api.free2convey.co.uk/api/ChainEntryList/SetLastFirmInChain/53
Output
On success: true
On error: false
Exceptions
Exception type Exception message
ChainNoLongerExistException Current chain entry no longer exists
Add next firm
Description
Join chain invitation.
Method
URL: https://api.free2convey.co.uk/api/ChainViewEntry/JoinChainInvitation
type: POST
headers: { Authorization: 'Bearer ' + access_token }
Input parameters
Name Type Size Description Mandatory
Description string 500 Chain description Yes
Company object Company details Yes
CompanyId int Company id Yes (set to 0 if you don't have a CompanyId)
CompanyName string 128 Company name Yes
Address1 string 256 Company address Yes
Address2 string 256 Company address No
Address3 string 256 Company address No
Town string 128 Town No
County string 128 County No
PostCode string 8 Post code No
CompanyPhoneNo string 32 Company phone no No
CompanyFaxNo string 32 Company fax no No
CompanyEmailAddress string 254 Company email address Yes
CompanyIsGuest bool Company is guest Yes
UserTitle string 16 User title Yes
UserFirstName string 64 User first name Yes
UserLasttName string 64 User last name Yes
UserEmail string 50 User email Yes
UserPhoneNo string 50 User phone number No
UserMobileNo string 50 User mobile no No
UserFaxNo string 50 User fax no No
ObjectState int Object state Yes
BuyProperty object Object state Yes (if SellProperty is equal to null)
PropertyId int You can either search for a property and set the PropertyId if found or the JoinChainInvitation will do an automatic search and add the property on the chain Yes (set to 0 if you don't have a PropertyId)
BuildingName string 100 Building name Yes (if building number is empty) No (if building number is not empty)
BuildingNo string 50 Building number Yes (if building number is empty) No (if building number is not empty)
StreetName string 100 Street name Yes
CityName string 100 City name No
Postcode string 10 Post code Yes
TitleNumber string 128 Title number No
Tenure string Tenure No
ActionPermited enum (ActionPermited) Action permitted Yes
SellProperty object Sell property Yes (if SellProperty is equal to null)
InvitationChainInfo object Invitator chain info No
InvitatorChainEntryId int Invitator chain entry id Yes
PropertyTransactionType enum (PropertySearchType) Property transaction type Yes
MustAddJoinProperty bool Must add join property Yes
InvitationExludedPropertyId int Invitation exluded property id Yes
Input example
{ 
   "Description":"tr6",
   "Company":{ 
      "CompanyId":5,
      "CompanyName":"Company 1",
      "Address1":"company 1",
      "Address2":null,
      "Address3":null,
      "Town":null,
      "County":null,
      "PostCode":"AA99 9AA",
      "CompanyPhoneNo":null,
      "CompanyFaxNo":null,
      "CompanyEmailAddress":"office@domain.co.uk",
      "CompanyIsGuest":false,
      "UserTitle":null,
      "UserFirstName":"company first name",
      "UserLasttName":"company last name",
      "UserEmail":"user@domain.co.uk",
      "UserPhoneNo":null,
      "UserMobileNo":null,
      "UserFaxNo":null,
      "ObjectState":0
   },
   "BuyProperty":{ 
      "PropertyId":0,
      "BuildingName":"b6",
      "BuildingNo":null,
      "StreetName":"s6",
      "CityName":"c6",
      "Postcode":"AA99 9AA",
      "TitleNumber":"DN106",
      "Tenure":null,
      "ActionPermited":0,
      "ObjectState":0
   },
   "SellProperty":null,
   "InvitationChainInfo":{ 
      "InvitatorChainEntryId":10,
      "PropertyTransactionType":1,
      "MustAddJoinProperty":true,
      "InvitationExludedPropertyId":5
   },
   "ObjectState":0
}
Output
On success: true
On error: false
Exceptions
Exception type Exception message
DataValidationException Data validation failed: [validation errors]
PropertyHasBeenFoundToBuyButYouAreSellingException Property has been found, but you cannot buy the same property you are selling. Please search for another property.
PropertyHasBeenFoundToSellButYouAreBuyingException Property has been found, but you cannot sell the same property you are buying. Please search for another property.
PropertyThaiIsBeingPurchasedFoundButUnavailableException Property that is being purchased by your client has been found, but it is unavailable.
PropertyThaiIsBeingSoldFoundButUnavailableException Property that is being sold by your client has been found, but it is unavailable.
BuyPropertyDoesNoLongerExistsException The buy property does no longer exist.
SellPropertyDoesNoLongerExistsException The sell property does no longer exist.
NoPropertySelectedException Join chain entry invitator does not have a property selected.
ContactRegisterdToAnotherCompanyException There already exists the contact email address registered to another company. Please change the email address and try again.
AlreadyExistsADifferentCompanyWithTheSameEmailAddressException There already exists a different company with the same email address. Please change the email address and try again.
AlreadyExistsACompanyWithTheSameEmailAddressException There already exists a company with the same email address. Please change the email address and try again.
ContactRegisterdToAnotherCompanyException There already exists the contact email address registered to another company. Please change the email address and try again.
NotificationEmailCouldNotBeSendException The notification email could not be sent.
Add/join chain
Description
Add or join chain.
Method
URL: https://api.free2convey.co.uk/api/ChainViewEntry/Add
type: POST
headers: { Authorization: 'Bearer ' + access_token }
Input parameters
Name Type Size Description Mandatory
CompanyId int Company id No
Description string 500 Description Yes
ClientName string 256 Client name No
ClientNumberRef string 128 Client number ref No
FeeEarnerId string 128 Fee earner id No
IsFirstTransaction bool Check if is first transaction true
IsLastTransaction bool Check if is last transaction true
IsSaleAndPurchase bool Sale and purchase true
IsMultiplePropertySale bool Multiple property sale true
BuyProperty object Object state Yes (if SellProperty is equal to null)
PropertyId int You can either search for a property and set the PropertyId if found or the JoinChainInvitation will do an automatic search and add the property on the chain Yes (set to 0 if you don't have a PropertyId)
BuildingName string 100 Building name Yes (if building number is empty) No (if building number is not empty)
BuildingNo string 50 Building number Yes (if building number is empty) No (if building number is not empty)
StreetName string 100 Street name Yes
CityName string 100 City name No
Postcode string 10 Post code Yes
TitleNumber string 128 Title number No
Tenure string Tenure No
ActionPermited enum Action permitted Yes
SellProperty object Sell property Yes (if SellProperty is equal to null)
InvitationChainInfo object Invitator chain info No
InvitatorChainEntryId int Invitator chain entry id Yes
PropertyTransactionType enum Property transaction type Yes
MustAddJoinProperty bool Must add join property Yes
InvitationExludedPropertyId int Invitation exluded property id Yes
Action permitted
Key Value
1 NewChain
2 JoinChain
3 BlockFoundOnActiveBuy
4 BlockFoundOnActiveSell
Property search type
Key Value
1 Buy
2 Sell
Input example
{
   "CompanyId":0,
   "Description":"chain invite 10",
   "ClientName":"Walter",
   "ClientNumberRef":null,
   "FeeEarnerId":"727c150c-508f-40d8-bad7-3974d1ea5d2b",
   "IsFirstTransaction":true,
   "IsLastTransaction":false,
   "IsSaleAndPurchase":false,
   "IsMultiplePropertySale":false,
   "InvitationChainInfo":null,
   "BuyProperty":{
      "PropertyId":-1,
      "BuildingName":"b8",
      "BuildingNo":null,
      "StreetName":"b8",
      "CityName":"b8",
      "Postcode":"AA99 9AA",
      "TitleNumber":"DN108",
      "Tenure":0,
      "ActionPermited":1,
      "ObjectState":0
   },
   "SellProperty":null,
   "ObjectState":0
}
Output
Name Type Size Description Mandatory
ChainId int Chain id Yes
ChainEntryId int Chain entry id Yes
Output example
{ 
   "ChainId":11,
    "ChainEntryId":15
}
Exceptions
Exception type Exception message
DataValidationException Data validation failed: [validation errors]
PropertySameTitleNumberException Buy property and sell property can't have the same title number!
PropertySameAddressException Buy property and sell property can't have the same address!
Set completed
Description
Set last firm in chain.
Method
URL: https://api.free2convey.co.uk/api/ChainViewEntry/UpdateSetLastFirmInChain/id
Type: GET
Headers: { Authorization: 'Bearer ' + access_token }
Input parameters
Name Type Size Description Mandatory
Id int Chain entry id Yes
Input example
https://api.free2convey.co.uk/api/ChainViewEntry/UpdateSetLastFirmInChain/53
Output
On success: true
On error: false
Get all property
Description
Return all property.
Method
URL: https://api.free2convey.co.uk/api/ChainViewEntry/SearchProperty
Type: GET
Headers: { Authorization: 'Bearer ' + access_token }
Input parameters
Name Type Size Description Mandatory
BuildingName string 100 Building name Yes (if building number is empty) No (if building number is not empty)
BuildingNo string 50 Building number Yes (if building number is empty) No (if building number is not empty)
StreetName string 100 Street name Yes
CityName string 100 City name No
Postcode string 10 Post code Yes
TitleNumber string 128 Title number No
Tenure int Tenure No
PropertySearchType enum Property search type Yes
Property search type
Key Value
1 Buy
2 Sell
Input example
{ 
   "BuildingName":"",
   "BuildingNo":"",
   "StreetName":"",
   "PostCode":"",
   "CityName":"",
   "TitleNumber":"DN100",
   "Tenure":0,
   "PropertySearchType":1
}
Output
Name Description
PropertyId Property id
BuildingName Building name
BuildingNo Building number
StreetName Street name
PostCode Post code
CityName City name
TitleNumber Title number
Tenure Tenure
ActionPermited Action permitted
PropertyTransactionType Property transaction type
Action permitted
Key Value
1 NewChain
2 JoinChain
3 BlockFoundOnActiveBuy
4 BlockFoundOnActiveSell
Property search type
Key Value
1 Buy
2 Sell
Output example
{ 
   "PropertyId":111,
   "BuildingName":"",
   "BuildingNo":"27",
   "StreetName":"FLAKE AVENUE",
   "CityName":"Exeter",
   "Postcode":"EX56 4HY",
   "TitleNumber":"DN100",
   "Tenure":20,
   "CreatedBy":null,
   "CreatedOn":"0001-01-01T00:00:00",
   "LastModifiedBy":null,
   "LastModifiedOn":"0001-01-01T00:00:00",
   "ChainEntries_BuyPropertyId":[],
   "ChainEntries_SellPropertyId":[],
   "PropertyTransactionType":0,
   "CompanyId":2,
   "CompanyName":"Moeliss & Company",
   "ActionPermited":3,
   "ObjectState":0
}
Get property by id
Description
Return property description.
Method
URL: https://api.free2convey.co.uk/api/ChainViewEntry/GetPropertyById/id
Type: GET
Headers: { Authorization: 'Bearer ' + access_token }
Input parameters
Name Type Size Description Mandatory
Id int Chain entry id Yes
Input example
https://api.free2convey.co.uk/api/ChainViewEntry/GetPropertyById/53
Output
Name Description
PropertyId Property id
BuildingName Building name
BuildingNo Building number
StreetName Street name
PostCode Post code
CityName City name
TitleNumber Title number
Tenure Tenure
ActionPermited Action permitted
Action permitted
Key Value
1 NewChain
2 JoinChain
3 BlockFoundOnActiveBuy
4 BlockFoundOnActiveSell
Output example
{ 
   "PropertyId":0,
   "BuildingName":"",
   "BuildingNo":"",
   "StreetName":"",
   "PostCode":"",
   "CityName":"",
   "TitleNumber":"DN100",
   "Tenure":0,
   "ActionPermited":1
}
Invite guest user
Description
Invite a guest user to a chain entry on Web portal.
Method
URL: https://api.free2convey.co.uk/api/ChainViewEntry/InviteChainEntryUserGuest
Type: POST
Headers: { Authorization: 'Bearer ' + access_token }
Input parameters
Name Type Size Description Mandatory
ChainId int The chain id Yes
Email string 256 Guest user email Yes
Title string 16 Guest user title Yes
FirstName string 64 Guest user first name Yes
LastName string 64 Guest user last name Yes
MobileNo string 32 Guest user mobile number No
PhoneNo string 32 Guest user phone number No
FaxNo string 32 Guest user fax number No
ObjectState int 0 Yes
Input example
{
   "ChainId":0,
   "Email":null,
   "Title":null,
   "FirstName":null,
   "LastName":null,
   "MobileNo":null,
   "PhoneNo":null,
   "FaxNo":null,
   "ObjectState":0
}
Output
Name Description
Type Result type
Title Result title
Description Result description
Output example
{
   "Type":0,
   "Title":null,
   "Description":null
}
Exceptions
Exception type Exception message
UserExistsAndIsNotGuest The user exists and is not guest.
Invite guest user2
Description
Invite a guest user to a chain entry on Web portal and return the newly created user id.
Method
URL: https://api.free2convey.co.uk/api/ChainViewEntry/InviteChainEntryUserGuest2
Type: POST
Headers: { Authorization: 'Bearer ' + access_token }
Input parameters
Name Type Size Description Mandatory
ChainId int The chain id Yes
Email string 256 Guest user email Yes
Title string 16 Guest user title Yes
FirstName string 64 Guest user first name Yes
LastName string 64 Guest user last name Yes
MobileNo string 32 Guest user mobile number No
PhoneNo string 32 Guest user phone number No
FaxNo string 32 Guest user fax number No
ObjectState int 0 Yes
Input example
{
   "ChainId":0,
   "Email":null,
   "Title":null,
   "FirstName":null,
   "LastName":null,
   "MobileNo":null,
   "PhoneNo":null,
   "FaxNo":null,
   "ObjectState":0
}
Output
Name Type Length Description Mandatory
UserId int User id Yes
Output example
{
   "UserId": 10
}
Exceptions
Exception type Exception message
UserExistsAndIsNotGuest The user exists and is not guest.
Invite guest company
Description
Invite a guest company to a chain entry on Web portal by creating an admin company.
Method
URL: https://api.free2convey.co.uk/api/ChainViewEntry/InviteChainEntryCompanyGuest
Type: POST
Headers: { Authorization: 'Bearer ' + access_token }
Input parameters
Name Type Size Description Mandatory
ChainId int The chain id Yes
ChainEntryId int Chain entry id Yes
CompanyId int Company id Yes
CompanyIsGuest bool Is guest Yes
CompanyName string 128 Company name Yes
CompanyAddress1 string 256 Company address Yes
CompanyAddress2 string 256 Company address No
CompanyAddress3 string 256 Company address No
CompanyTown string 128 Town No
CompanyCounty string 128 County No
CompanyPostCode string 8 Post code No
CompanyPhoneNo string 32 Company phone no No
CompanyFaxNo string 32 Company fax no No
CompanyEmailAddress string 254 Company email address Yes
UserTitle string 16 User title Yes
UserFirstName string 64 User first name Yes
UserLasttName string 64 User last name Yes
UserPhoneNo string User phone number No
UserMobileNo string 32 User mobile no No
UserFaxNo string 32 User fax no No
UserEmail string 50 User email Yes
ObjectState int Object state Yes
Input example
{
   "ChainId":13,
   "ChainEntryId":26,
   "CompanyId":6,
   "CompanyIsGuest":true,
   "CompanyName":"Guest Company 1",
   "CompanyAddress1":"guest address 1",
   "CompanyAddress2":null,
   "CompanyAddress3":null,
   "CompanyTown":null,
   "CompanyCounty":null,
   "CompanyPostCode":"AA99 9AA",
   "CompanyPhoneNo":null,
   "CompanyFaxNo":null,
   "CompanyEmailAddress":"office@domain.co.uk",
   "UserTitle":"Mr",
   "UserFirstName":"guest first name",
   "UserLastName":"guest last name",
   "UserMobileNo":null,
   "UserPhoneNo":null,
   "UserFaxNo":null,
   "UserEmail":"user@domain.co.uk",
   "ObjectState":0
}
Output
Name Description
Type Type
Title Title
Description Description
Output example
{
   "Type":0,
   "Title":null,
   "Description":null
}
Exceptions
Exception type Exception message
UserExistsAndIsNotGuest The user exists and is not guest.
Invite guest company2
Description
Invite a guest company to a chain entry on Web portal by creating an admin company and return the newly created company id.
Method
URL: https://api.free2convey.co.uk/api/ChainViewEntry/InviteChainEntryCompanyGuest2
Type: POST
Headers: { Authorization: 'Bearer ' + access_token }
Input parameters
Name Type Size Description Mandatory
ChainId int The chain id Yes
ChainEntryId int Chain entry id Yes
CompanyId int Company id Yes
CompanyIsGuest bool Is guest Yes
CompanyName string 128 Company name Yes
CompanyAddress1 string 256 Company address Yes
CompanyAddress2 string 256 Company address No
CompanyAddress3 string 256 Company address No
CompanyTown string 128 Town No
CompanyCounty string 128 County No
CompanyPostCode string 8 Post code No
CompanyPhoneNo string 32 Company phone no No
CompanyFaxNo string 32 Company fax no No
CompanyEmailAddress string 254 Company email address Yes
UserTitle string 16 User title Yes
UserFirstName string 64 User first name Yes
UserLasttName string 64 User last name Yes
UserPhoneNo string User phone number No
UserMobileNo string 32 User mobile no No
UserFaxNo string 32 User fax no No
UserEmail string 50 User email Yes
ObjectState int Object state Yes
Input example
{
   "ChainId":13,
   "ChainEntryId":26,
   "CompanyId":6,
   "CompanyIsGuest":true,
   "CompanyName":"Guest Company 1",
   "CompanyAddress1":"guest address 1",
   "CompanyAddress2":null,
   "CompanyAddress3":null,
   "CompanyTown":null,
   "CompanyCounty":null,
   "CompanyPostCode":"AA99 9AA",
   "CompanyPhoneNo":null,
   "CompanyFaxNo":null,
   "CompanyEmailAddress":"office@domain.co.uk",
   "UserTitle":"Mr",
   "UserFirstName":"guest first name",
   "UserLastName":"guest last name",
   "UserMobileNo":null,
   "UserPhoneNo":null,
   "UserFaxNo":null,
   "UserEmail":"user@domain.co.uk",
   "ObjectState":0
}
Output
Name Type Length Description Mandatory
CompanyId int Company id Yes
Output example
{
   "CompanyId": 6
}
Exceptions
Exception type Exception message
UserExistsAndIsNotGuest The user exists and is not guest.
Remove my firm
Description
Remove my firm by chain entry id.
Method
URL: https://api.free2convey.co.uk/api/ChainEntryList/RemoveFirmInChain/id
Type: POST
Headers: { Authorization: 'Bearer ' + access_token }
Input parameters
Name Type Size Description Mandatory
Id int Chain id Yes
Input example
https://api.free2convey.co.uk/api/ChainEntryList/RemoveFirmInChain/53
Output
On success: true
On error: false
Exceptions
Exception type Exception message
ChainNoLongerExistException Current chain entry no longer exists
Remove firm below
Description
Remove firm below by chain entry id.
Method
URL: https://api.free2convey.co.uk/api/ChainEntryList/RemoveFirmBelowInChain/id
Type: POST
Headers: { Authorization: 'Bearer ' + access_token }
Input parameters
Name Type Size Description Mandatory
Id int Chain id Yes
Input example
https://api.free2convey.co.uk/api/ChainEntryList/RemoveFirmBelowInChain/53
Output
On success: true
On error: false
Exceptions
Exception type Exception message
ChainNoLongerExistException Current chain entry no longer exists
Remove firm above
Description
Remove firm above by chain entry id.
Method
URL: https://api.free2convey.co.uk/api/ChainEntryList/RemoveFirmAboveInChain/id
Type: POST
Headers: { Authorization: 'Bearer ' + access_token }
Input parameters
Name Type Size Description Mandatory
Id int Chain id Yes
Input example
https://api.free2convey.co.uk/api/ChainEntryList/RemoveFirmAboveInChain/53
Output
On success: true
On error: false
Exceptions
Exception type Exception message
ChainNoLongerExistException Current chain entry no longer exists