Services

These web services can be used by Introducer users and Supplier users as indicated in these documents these coloured badges will appear to try and make it clear which services or methods apply to each type of user.

Examples of requests made to the services please see the Examples page.

The functionality in the API is split up as described below:

For all users

• Authentication - used to get a token for Bearer authentication. Alternatively Basic authentication can be used which does not require using this service.
• Instruction - to retrieve an instruction.
• Instructions search - to find instructions.
• Instruction notification - to retrieve notifications about updates to instructions.
• Notes - to add notes.
• Data - to retrieve data.

For introducers Introducer

• Referral - to create a direct referral and lead.
• Quote - to create a quote and refer it.
• Quotes search - to search for quotes.

There is also an alternative approach to keeping up to date - this is email integration or email automation. Whilst not a recommended approach information can be found at Email integration.

For suppliers Supplier

• Supplier operations - to perform operations on an Instruction

Testing

When instructions are received by the team at The Moving Portal, they will go through some due diligence checks and then progress the case. Once assigned to a supplier a case will be progressed by them to completion.

For introducer:

• For direct referrals and some quotes: Accept/Confirm or Reject the case
• Take payment - usually to mark the case as ordered
• Assign the case to a supplier
• Deallocate a case from a supplier
• Book (and rebook) an appointment (usually performed by supplier)
• Cancel appointment
• Change product
• Complete case (usually performed by supplier)
• Cancel case
• Put case on hold or take off hold
• Change customers or property details
• Add a note
• Fee change
• Uncancel (for a referral only)

For supplier:

• Assign a case to them
• Deallocate a case from a supplier
• Cancel appointment
• Change product
• Cancel case
• Put case on hold or take off hold
• Change customers or property details
• Add a note
• Fee change

Additionally for a supplier it is necessary to have some way to create test cases.

We have created interactive functionality in the development environment. This Integration Development Console to allow for an integrator to be able to perform the majority of these operations.

Please see the Testing overview.