Inspections
Provides methods for managing inspections in CRM.
| API | Description |
|---|---|
| GET api/Inspections/{id} |
Returns an inspection by id. Note: Requires a valid access token to be provided in the request's auth header. |
| GET api/Inspections/{id}/Areas?withChildren={withChildren} |
Returns the list of areas related to the given inspection. |
| POST api/Inspections/{id}/Notes |
Creates a new note for the given inspection. Note: Requires a valid access token to be provided in the request's auth header. |
| POST api/Inspections/{id}/Validate |
Creates a new queued activity to validate the given inspection. Note: Requires a valid access token to be provided in the request's auth header. |
| POST api/Inspections/{id}/media |
Inserts the given media to crm. Note: Requires a valid access token to be provided in the request's auth header. |
| PATCH api/Inspections/{id}/StatementOfWork |
Inserts the given statement of work to crm. Note: Requires a valid access token to be provided in the request's auth header. |
| POST api/Inspections/{id}/StatementOfWorkItem |
Inserts the given statement of work item to crm. Note: Requires a valid access token to be provided in the request's auth header. |
| PUT api/Inspections/{id} |
Updates inspection in CRM by id. Note: Requires a valid access token to be provided in the request's auth header. |
StatementsOfWork
Provides methods for managing statements of work in CRM.
| API | Description |
|---|---|
| GET api/StatementsOfWork/{id}/StatementOfWorkItems |
Returns the list of statement of work items related to the given statement of work. |
| GET api/StatementsOfWork/{id} |
Returns an statement of work by id. Note: Requires a valid access token to be provided in the request's auth header. |
Diagnostics
Class used to provide diagnositic methods.
| API | Description |
|---|---|
| GET api/Diagnostics/Exception |
Artifically causes an exception to be thrown to test exception handling framework. |
| POST api/Diagnostics/Feedback |
Used to provide user feedback directly to the developers. |
| POST api/Diagnostics/Log |
Forwards the log to the logging framework |
| GET api/Diagnostics/Entity?id={id}&logicalName={logicalName} |
Artifically causes an exception to be thrown to test exception handling framework. |
| POST api/Diagnostics/Media |
Tests the media stream upload |
| GET api/Diagnostics |
Returns the current user's claims excluding thier password. |
Tokens
Provides methods for issuing, refreshing, and invalidating security tokens.
| API | Description |
|---|---|
| GET api/Tokens/ping |
Returns the full name of the executing assembly after validating the access token. |
| GET api/Tokens |
Issues both an access and refresh token based on the CRM credentials provided via basic authentication in the form of email and password. Note: Custom header X-MSRenewal required to uniquely identify client requesting token in order to validate refresh token later when client calls PATCH /api/token. |
| PATCH api/Tokens |
Issues new access and refresh tokens based on the refresh token provided in the request's auth header. Note: Custom header X-MSRenewal required to uniquely identify client requesting token in order to validate refresh token. |
| DELETE api/Tokens |
Invalidates refresh token provided in auth header. Note: Custom header X-MSRenewal required to uniquely identify client requesting token in order to validate refresh token. |
Media
Provides method for updating media in CRM.
| API | Description |
|---|---|
| PUT api/Media/{id} |
Updates the given media to crm, excluding the data field. All fields are updated except Data, CapturedDate and Tags. Note: Requires a valid access token to be provided in the request's auth header. |
| PUT api/Media/{id}/Data |
Updates the given media to crm, including the data field. All fields are updated except CapturedDate and Tags. Note: Requires a valid access token to be provided in the request's auth header. |
Homes
Provides methods for managing homes in CRM.
| API | Description |
|---|---|
| GET api/Homes/Inspections?withChildren={withChildren}&onlyCompleted={onlyCompleted}&oldMethod={oldMethod} |
Returns the list of homes with inspections assigned to the authenticated user in CRM. Note: Requires a valid access token to be provided in the request's auth header. |
| GET api/Homes/Search?q={q}&maxResults={maxResults}&lat={lat}&lon={lon} |
Returns the list of homes searched from CRM. Note: Requires a valid access token to be provided in the request's auth header. |
| GET api/Homes/{homeid}/Jobs |
Returns the list of jobs for searched home from CRM. Note: Requires a valid access token to be provided in the request's auth header. |
| POST api/Homes/{homeid}/ChangeRequests/{jobid} |
Returns a successful response of change request inspection assignment for a given job and home from CRM. Note: Requires a valid access token to be provided in the request's auth header. |
| GET api/Homes/{homeid}/ChangeRequests/{jobid}?imagePrefix={imagePrefix}&withChildren={withChildren} |
Returns CR Inspection and Original Inspection for a given job and home from CRM. Note: Requires a valid access token to be provided in the request's auth header. |
| GET api/Homes/{id}/Inspections?filterByUser={filterByUser}&withChildren={withChildren}&includeFinalized={includeFinalized} |
Returns the list of inspections related to the given home. |
| GET api/Homes/{id}/StatementsOfWork |
Returns the list of statements of work related to the given home. |
| GET api/Homes/Projects |
Returns the list of homes with projects assigned to the authenticated user in CRM. Note: Requires a valid access token to be provided in the request's auth header. |
| POST api/Homes/{id}/media |
Inserts the given media to crm. Note: Requires a valid access token to be provided in the request's auth header. |
StatementOfWorkItems
Provides methods for managing statements of work in CRM.
| API | Description |
|---|---|
| PUT api/StatementOfWorkItems/{id} |
Updates statement of work item in CRM by id. Note: Requires a valid access token to be provided in the request's auth header. |
| DELETE api/StatementOfWorkItems/{id} |
Deletes the statement of work item by id. |
ProductsAndServices
Provides methods for managing products and services in CRM.
| API | Description |
|---|---|
| GET api/ProductsAndServices/Pricing |
Returns a list of product pricing groups in PM |
| GET api/ProductsAndServices |
Returns a list of products and services from CRM. |
MediaBrowser
Serves MediaBrowersNodes to the MediaBrowser Component
| API | Description |
|---|---|
| GET api/MediaBrowser/Media/{logicalName}/{id}?includeInactive={includeInactive} |
Returns Media metadata for a CRM Entity Valid Entities: msr_home, msr_inspection, msr_area |
| GET api/MediaBrowser/Media/{logicalName}/propertyId/{propertyId} |
No documentation available. |
Files
Provides methods for managing files.
| API | Description |
|---|---|
| GET api/Files/{id}/Content |
Returns the file with the Base64 encoded content. |
| GET api/Files/{id}/File |
Returns the binary file decoded from base64 encoded Content field. |
| GET api/Files/{id}/File.mp4 |
Returns the binary file decoded from base64 encoded Content field. |
| GET api/Files/Albums/{album} |
Returns a list of files based on the given album. |
| GET api/Files/Tags/{tag} |
Returns a list of files based on the given tag. |
| GET api/Files/{id}/Tags |
Returns the set of tag strings for the file. |
| POST api/Files/{id}/Tags/{tag} |
Inserts a tag into the file's tag collection. |
| DELETE api/Files/{id}/Tags/{tag} |
Inserts a tag into the file's tag collection. |
| GET api/Files/{id} |
Returns the file without the Base64 encoded content. |
| POST api/Files |
Inserts the given file into storage. |
| PUT api/Files |
Updates the given file in storage. All fields are updated except CreatedOn, CapturedDate and Tags. |
| DELETE api/Files |
Deletes a file from storage. |
Directive
| API | Description |
|---|---|
| GET api/Directives/all | |
| POST api/Directives/refreshall |
Areas
Provides methods for managing areas in CRM.
| API | Description |
|---|---|
| GET api/Areas/{id}/InspectionItems?withChildren={withChildren} |
Returns the list of inspection items related to the given area. |
| POST api/Areas/{id}/media |
Inserts the given media to crm. Note: Requires a valid access token to be provided in the request's auth header. |
| POST api/Areas/{id}/notes |
Inserts the given note to CRM. Note: Requires a valid access token to be provided in the request's auth header. |
| GET api/Areas/{id} |
Returns an area by id. Note: Requires a valid access token to be provided in the request's auth header. |
RepairScope
| API | Description |
|---|---|
| GET api/RepairScopes/{id} |
Returns a repair scope by id. Note: Requires a valid access token to be provided in the request's auth header. |
| GET api/RepairScopes |
InspectionItems
Provides methods for managing inspection items in CRM.
| API | Description |
|---|---|
| GET api/InspectionItems/{id}/Measurements |
Returns the list of measurements related to the given inspection item. |
| PUT api/InspectionItems/{id}/Measurements/{measurementId} |
Updates the specified measurement for the given inspection item. Note: Requires a valid access token to be provided in the request's auth header. |
| POST api/InspectionItems/{id}/Media |
Inserts the given media to crm. Note: Requires a valid access token to be provided in the request's auth header. |
| POST api/InspectionItems/{id}/Notes |
Creates a new note for the given inspection item. Note: Requires a valid access token to be provided in the request's auth header. |
| POST api/InspectionItems/{id}/Measurements |
Creates a new measurement for the given inspection item. Note: Requires a valid access token to be provided in the request's auth header. |
| GET api/InspectionItems/{id} |
Returns an inspection item by id. Note: Requires a valid access token to be provided in the request's auth header. |
| PUT api/InspectionItems/{id} |
Updates inspection item in CRM by id. Note: Requires a valid access token to be provided in the request's auth header. |
Ping
Class used to support ping requests for check service availability.
| API | Description |
|---|---|
| GET api/Ping |
Returns the full name of the executing assembly. |
Projects
Provides methods for managing homes in CRM.
| API | Description |
|---|---|
| GET api/Projects/{id} |
Returns a project by id. Note: Requires a valid access token to be provided in the request's auth header. |
HomeImages
Provides methods for fetching home images from internal file share.
| API | Description |
|---|---|
| GET api/HomeImages |
Returns a list of URLs for all home images from internal file share. |
| GET api/HomeImages/{id} |
Returns the image from internal file share by id. |
Templates
Provides methods for fetching templates from CRM.
| API | Description |
|---|---|
| GET api/Templates |
Returns a templates object from CRM. |
AnalyticEvents
Class used to capture analytic events.
| API | Description |
|---|---|
| POST api/AnalyticEvents |
Creates a new analytic event in CRM and returns the object. |
PropertyMap
Provides methods for getting Map Pins for Properties
| API | Description |
|---|---|
| GET api/PropertyMap?branches[0]={branches[0]}&branches[1]={branches[1]} |
No documentation available. |
Branches
Provides methods for managing Branches in CRM
| API | Description |
|---|---|
| GET api/Branches |
Gets Branch Business Units |