SOAP to REST Conversion
  • 31 Jul 2024
  • PDF

SOAP to REST Conversion

  • PDF

Article summary

Convert from Aspire’s External SOAP API to Aspire’s External REST API.

Authentication differences 

The SOAP API uses a static username and password configured by Aspire CARE to retrieve a token per Entity Service.

The REST API uses a Bearer token that has expiration dates. You can retrieve these tokens from /Authorization with a user-generated ClientID and Secret. For more information, see Authentication & Authorization.

Specific Object Equivalents in Aspire Production

Select the following image to enlarge it, and reference the table below for the links to an object's SOAP and REST equivalent endpoints. 

Links to specificobject's SOAP and REST equivalent endpoints in Aspire Production:

ObjectSOAPREST Equivalent EndPoint
CompaniesCompanies ServiceCompanies
ContactsContacts ServiceContacts
Pay Schedules
Pay Rates
DepositsDeposits ServiceBank Deposits
InvoicesARInvoicesInvoices
Invoice Batches
Branches
Properties
Payment Terms
Item AllocationInventoryTransactions ServiceItem Allocations
Receipts
Work Tickets
Opportunity Services
Services
Service Types
Divisions
Catalog Items
Catalog Item Categories
Unit Types
OpportunitiesOpportunities ServiceOpportunities
PaymentsPayments ServicePayments
Branches
Contacts
Divisions
PropertiesProperties ServiceProperties
Property Contacts
Property Statuses
Localities
Purchase ReceiptsPurchases ServiceReceipts
Vendors
Receipt Statuses
Inventory Locations
Work Ticket TimeTimeEntries ServiceWork Ticket Times
Branches
UsersUsers ServiceUsers
VendorsVendors ServiceVendors
Work TicketsWorkTickets ServiceWork Tickets
Opportunity Services
Opportunities
Properties
Property Groups
Contacts
Regions
Work Ticket Visits
Routes

Was this article helpful?

What's Next
Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.