Supported Endpoints

As specified in the documentation for the Base Endpoint exposed for each service, all operations are exposed via essentially the same url.

You’ll find the following HTTP verbs supported

GET Model Collection

VERB: GET{Username}/{ModelName}s

This can be modified in several ways to manipulated what is returned using the following basic operations.

  1. orderBy -> should function with all string, integer, and date types…bool too by why??
  2. pageSize -> a number not to exceed 25
  3. pageNumber -> this is numeric and generally best used after the first query so you have some idea where paging will begin
  4. fields -> A comma delimited list of fields from the models you wish to have returned

These are attached as query parameters.{Username}/{ModelName}s?fields={fieldName}&pageSize=2&pageNumber=2

GET Model By Id

VERB: GET{USerName}/{ModelName}s/{guid of the format: f7c4229c-2d98-4f22-9c6b-08d7331c1e2a}


VERB: POST BODY: see Model For Creation DTO{Username}/{ModelName}s


VERB: PUT BODY: see Mode For Update DTO{Username}/{ModelName}s

Partially Update Model

VERB: PATCH BODY: Patch document with standard PATCH operations and model properties as found in the Model For Update DTO{USerName}/{ModelName}s/{guid of the format: f7c4229c-2d98-4f22-9c6b-08d7331c1e2a}

DELETE Model By Id

VERB: DELETE{USerName}/{ModelName}s/{guid of the format: f7c4229c-2d98-4f22-9c6b-08d7331c1e2a}