Relocation Service API

This document describes the Relocation Service API.

This page describes the RESTful APIs for Relocation Service. The APIs facilitate CRUD operations on the various resources for relocation service (Onboarding Plans , Onboarding Resources etc.) and allow operations on them (creating onboarding plan , get onboarding plans etc.).

Some of the APIs that list collections of resources also support OData like implementation. Below query params can be used across Relocation Service entities.

Example:

1. $orderby - returns a result with the rows being sorted by the values of provided attribute.

   /relocation/onboarding/plan?$orderby=name%20desc

2. $top - number of records you want to get.

   /relocation/onboarding/plan?$top=20

3. $skip - number of records you want to skip.

   /relocation/onboarding/plan?$skip=10

4. $filter - filter the results by a specified predicate expression. Operators: eq, ne, and, or.

   /relocation/onboarding/plan?$filter=name%20eq%20'ABC*' - name starts with 'ABC'

   /relocation/onboarding/plan?$filter=name%20eq%20'*ABC*' - name contains 'ABC'

   /relocation/onboarding/plan?$filter=name%20eq%20'*ABC' - name ends with 'ABC'

5. page, size - page used in conjunction with size helps in pagination of resources

   /relocation/onboarding/plan?page=0&size=20