ASP.NET Web API Help Page

Introduction

Provide a general description of your APIs here.

TestType

API	Description
GET api/testTypes/search?page={page}&take={take}&searchString={searchString}&sortByColumn={sortByColumn}&sortAscending={sortAscending}	No documentation available.
GET api/testTypes/{id}	No documentation available.

PushNotifications

API	Description
POST api/pushnotifications/custom	No documentation available.
POST api/pushnotifications/message	No documentation available.
POST api/pushnotifications/jobsonlysync	No documentation available.
POST api/pushnotifications/fullsync	No documentation available.
POST api/pushnotifications/formoradhocjobsonlysync	No documentation available.
POST api/pushnotifications/removejobsync	No documentation available.
PUT api/pushnotifications/registerdevice	No documentation available.
DELETE api/pushnotifications/unregisterdevice/{userId}	No documentation available.

Labour

API	Description
PUT api/labour	No documentation available.
GET api/labour/search?skip={skip}&take={take}&searchString={searchString}	No documentation available.
GET api/labour/{Id}	No documentation available.
PUT api/labour/update	No documentation available.
DELETE api/labour/{id}	No documentation available.

ContactTypes

API	Description
GET api/contacttypes	No documentation available.

JobTypes

API	Description
GET api/jobtypes	No documentation available.
GET api/jobtypes/published	No documentation available.
GET api/jobtypes/recentactivity?since={since}	No documentation available.
GET api/jobtypes/{id}	No documentation available.
GET api/jobtypes/{id}/full	No documentation available.
GET api/jobtypes/ids/search?currentState={currentState}&canRaiseOnDeviceOnly={canRaiseOnDeviceOnly}&includeInactive={includeInactive}&updatedAfter={updatedAfter}	<br/> Searches for a list of job type ids matching the criteria.<br/>

OrganisationTypes

API	Description
GET api/organisationtypes?skipTenantOrgType={skipTenantOrgType}	No documentation available.

Languages

API	Description
GET api/languages	No documentation available.

JobStates

API	Description
GET api/jobstates	No documentation available.
GET api/jobstates/allowed/{jobId}	No documentation available.

TestTaskTypes

API	Description
GET api/testTaskTypes/search?page={page}&take={take}&searchString={searchString}&sortByColumn={sortByColumn}&sortAscending={sortAscending}	No documentation available.
GET api/testTaskTypes/CountByTestTypeId/{id}	No documentation available.
GET api/testTaskTypes/forAssetTypes	No documentation available.
GET api/testTaskTypes/forAssetTypesOnSite/{siteId}	No documentation available.
GET api/testTaskTypes/{id}	No documentation available.

SectionTypes

API	Description
GET api/sectiontypes/recentactivity?since={since}	No documentation available.

Users

API	Description
GET api/users	No documentation available.
GET api/users/getactivenonclientusers	No documentation available.

AssetTypes

API	Description
GET api/assettypes	No documentation available.
GET api/assettypes/search?skip={skip}&take={take}&search={search}	<br/> Searches asset types.<br/>
GET api/assettypes/{id}	No documentation available.

Controls

API	Description
POST api/controls/{sectionId}	No documentation available.
POST api/controls/{sectionId}/{subsectionId}	No documentation available.

Assets

API	Description
GET api/assets/search?skip={skip}&take={take}&sortby={sortby}&sortAscending={sortAscending}&suspended={suspended}&searchString={searchString}	<br/> Searches assets.<br/>
GET api/assets/onsite/{siteId}	No documentation available.
GET api/assets/onsite/{siteId}/bysystems	No documentation available.
GET api/assets/onlocation?locationId={locationId}	No documentation available.
GET api/assets/{id}	No documentation available.
POST api/assets	No documentation available.
PUT api/assets/update	No documentation available.
DELETE api/assets/{id}	No documentation available.
DELETE api/assets/onsite/{siteId}	No documentation available.
PUT api/assets/{assetId}/suspend/{suspended}	No documentation available.

Parts

API	Description
PUT api/parts	No documentation available.
GET api/parts/search?skip={skip}&take={take}&searchString={searchString}	No documentation available.
GET api/parts/{Id}	No documentation available.
PUT api/parts/update	No documentation available.
DELETE api/parts/{id}	No documentation available.

Organisations

API	Description
GET api/organisations/getroot	No documentation available.
GET api/organisations	No documentation available.
GET api/organisations/{id}?visibleOnPortal={visibleOnPortal}	No documentation available.
GET api/organisations/{id}/users?skip={skip}&take={take}&sortAscending={sortAscending}&searchString={searchString}&sortBy={sortBy}	No documentation available.
GET api/organisations/allParents/{id}	No documentation available.
GET api/organisations/parents/{id}	No documentation available.
GET api/organisations/{id}/children	No documentation available.
POST api/organisations	No documentation available.
PUT api/organisations/0/{id}	No documentation available.
PUT api/organisations/1/{id}	No documentation available.
PUT api/organisations/2/{id}	No documentation available.
PUT api/organisations/3/{id}	No documentation available.
PUT api/organisations/4/{id}	No documentation available.
DELETE api/organisations/{id}	No documentation available.
GET api/organisations/{id}/descendants	No documentation available.
GET api/organisations/{id}/ancestors	No documentation available.
GET api/organisations/clients/search/{text}?take={take}&skip={skip}	No documentation available.
GET api/organisations/sitesfororganisation/{id}	No documentation available.

Titles

API	Description
GET api/titles	No documentation available.

Subsection

API	Description
POST api/subsections	No documentation available.

Sections

API	Description
POST api/sections/addsection?save={save}	No documentation available.
POST api/sections/savesection	No documentation available.
PUT api/sections/{id}	No documentation available.
DELETE api/sections/{jobId}/{id}	No documentation available.
GET api/sections/{jobId}	No documentation available.
GET api/sections/byid/{sectionId}	No documentation available.
GET api/sections/getjourney/{jobId}	No documentation available.
GET api/sections/recentactivity?since={since}	No documentation available.

Jobs

API	Description
GET api/jobs/search?skip={skip}&take={take}&sortByColumn={sortByColumn}&sortAscending={sortAscending}&dateFrom={dateFrom}&dateTo={dateTo}&jobTypeId={jobTypeId}&allocatedToId={allocatedToId}&stateIds[0]={stateIds[0]}&stateIds[1]={stateIds[1]}&siteId={siteId}&searchString={searchString}&orgId={orgId}	No documentation available.
GET api/jobs/{id}/customfields	No documentation available.
GET api/jobs/export?skip={skip}&take={take}&dateFrom={dateFrom}&dateTo={dateTo}&orgId={orgId}	No documentation available.
GET api/jobs/{id}	No documentation available.
GET api/jobs/{id}/full?includeAllocated={includeAllocated}	No documentation available.
GET api/jobs/v2/{id}/full	No documentation available.
GET api/jobs/{id}/full	No documentation available.
GET api/jobs/{id}/formdata?excludeTemplateSections={excludeTemplateSections}	No documentation available.
GET api/jobs/{id}/statehistory?skip={skip}&take={take}	No documentation available.
GET api/jobs/allocatedto/{id}	<br/> Returns a list of job ids allocated to passed user id<br/>
GET api/jobs/allocatedto	<br/> Returns a list of job ids allocated to the requesting user.<br/>
GET api/jobs/inprogress/{id}	<br/> Returns a list of job ids allocated to the passed user id<br/> that are in an 'in progress' state:<br/> OnDevice,<br/> InProgress,<br/> Uploading<br/>
GET api/jobs/inprogress	<br/> Returns a list of job ids allocated to the passed user id<br/> that are in an 'in progress' state:<br/> OnDevice,<br/> InProgress,<br/> Uploading<br/>
GET api/jobs/recentactivity?since={since}	No documentation available.
GET api/jobs/recenthistory?since={since}	No documentation available.
GET api/jobs/cancopyjob?jobId={jobId}	No documentation available.
GET api/jobs/caneditjobdata?jobId={jobId}	No documentation available.
GET api/jobs/caneditjobdetails?jobId={jobId}	No documentation available.
GET api/jobs/caneditsitesandcontacts?jobId={jobId}	No documentation available.
GET api/jobs/caneditnotes?jobId={jobId}	No documentation available.
GET api/jobs/cancomplete?jobId={jobId}	No documentation available.
GET api/jobs/cancompleteeditdata?jobId={jobId}	No documentation available.
GET api/jobs/cancancel?jobId={jobId}	No documentation available.
GET api/jobs/cangeneratedocument?jobId={jobId}	No documentation available.
GET api/jobs/cangetpdf/{id}	No documentation available.
GET api/jobs/candeallocate?jobId={jobId}	No documentation available.
POST api/jobs/multijob	No documentation available.
POST api/jobs	No documentation available.
POST api/jobs/full	<br/> Endpoint for submitting a new completed adhoc job from the mobile application.<br/>
POST api/jobs/clone/{jobId}	No documentation available.
POST api/jobs/uploadattachment	<br/> Endpoint for submitting job attachment meta data.<br/>
PUT api/jobs/uploadattachment/{attachementId}/data	No documentation available.
PUT api/jobs/uploadattachment/{attachementId}/multipartcontent	<br/> Endpoint for uploading the attachment data.<br/> <br/> Also send a thumbnail generation request.<br/>
PUT api/jobs/uploadattachment/{attachementId}/base64	No documentation available.
PUT api/jobs/{id}	No documentation available.
PUT api/jobs/{id}/full	<br/> Endpoint for updating a job in its entirety (all sections) from the mobile app.<br/>
PUT api/jobs/{jobId}/markAsReadyToComplete	<br/> Transitions an job from InProgress/Uploading to Review<br/>
PUT api/jobs/{jobId}/jobstate/{jobStateId}	No documentation available.
POST api/jobs/bulkUpdateState	No documentation available.
DELETE api/jobs/{id}	No documentation available.
GET api/jobs/{id}/haschildren	No documentation available.
POST api/jobs/generatedocumentation	<br/> Triggers a request to generate documentation for a job.<br/>
GET api/jobs/getpdfdata/{id}	<br/> Triggers a request to generate documentation for a job to be used in creating a pdf documnet.<br/>
GET api/jobs/getandwaitdocumentation/{id}	<br/> Tries to get the generated document.<br/>
GET api/jobs/getdocumentation/{id}	<br/> Tries to get the generated document.<br/>
GET api/jobs/getpdf/{id}	No documentation available.
GET api/jobs/getpdf/{id}/base64	No documentation available.
GET api/jobs/getdoclistforclient/{jobId}	No documentation available.
GET api/jobs/{jobId}/getuploadeddocuments	No documentation available.
GET api/jobs/getuploadeddocument/{documentId}	No documentation available.
GET api/jobs/getthumbnailsforjob/{jobId}	No documentation available.
GET api/jobs/{id}/summary	No documentation available.
POST api/jobs/{id}/confirmsummary	No documentation available.

Quotations

API	Description
PUT api/quotations	No documentation available.
PUT api/quotations/copy/{id}?asDraft={asDraft}	No documentation available.
GET api/quotations/search?skip={skip}&take={take}&searchString={searchString}&state={state}&from={from}&to={to}&minTotal={minTotal}&maxTotal={maxTotal}	No documentation available.
GET api/quotations/{Id}	No documentation available.
GET api/quotations/{Id}/invoice	No documentation available.
PUT api/quotations/update	No documentation available.
POST api/quotations/{Id}/calculate	No documentation available.
DELETE api/quotations/{id}	No documentation available.

Contacts

API	Description
GET api/contacts/all/{organisationId}	No documentation available.
GET api/contacts/{id}	No documentation available.
POST api/contacts	No documentation available.
PUT api/contacts	No documentation available.
DELETE api/contacts/{id}	No documentation available.

Invoices

API	Description
PUT api/invoices	No documentation available.
PUT api/invoices/copy/{id}	No documentation available.
GET api/invoices/search?skip={skip}&take={take}&searchString={searchString}&state={state}&from={from}&to={to}&minTotal={minTotal}&maxTotal={maxTotal}	No documentation available.
PUT api/invoices/createinvoice/{id}	No documentation available.
GET api/invoices/{Id}	No documentation available.
PUT api/invoices/update	No documentation available.
POST api/invoices/{Id}/calculate	No documentation available.
POST api/invoices/{Id}/paid	No documentation available.
DELETE api/invoices/{id}	No documentation available.

MonitoringVisits

API	Description
GET api/monitoringvisits/search?skip={skip}&take={take}&sortby={sortby}&sortAscending={sortAscending}&includeSuspended={includeSuspended}&dateFrom={dateFrom}&dateTo={dateTo}&searchString={searchString}	<br/> Searches job recurrences.<br/>
GET api/monitoringvisits/{id}	No documentation available.
GET api/monitoringvisits/{id}/jobsgenerated	No documentation available.
GET api/monitoringvisits/whatsdue/recurrencesduetogeneratejobs/search?skip={skip}&take={take}&includeSuspended={includeSuspended}&dateFrom={dateFrom}&dateTo={dateTo}&searchString={searchString}	<br/> Searches for recurrences which are due to generate jobs.<br/>
GET api/monitoringvisits/whatsdue/generatedjobs/search?skip={skip}&take={take}&includeSuspended={includeSuspended}&dateFrom={dateFrom}&dateTo={dateTo}&searchString={searchString}	<br/> Searches for jobs which have been generated from recurrences.<br/>
POST api/monitoringvisits/hypotheticalnextdate	<br/> Gets the hypothetical next date for a job recurrence which has not already been created.<br/>
POST api/monitoringvisits	No documentation available.
PUT api/monitoringvisits/{jobRecurrenceId}/generatenext	No documentation available.
PUT api/monitoringvisits/{id}	No documentation available.
DELETE api/monitoringvisits/{id}	No documentation available.

Estimates

API	Description
PUT api/estimates	No documentation available.
PUT api/estimates/copy/{id}?asDraft={asDraft}	No documentation available.
GET api/estimates/search?skip={skip}&take={take}&searchString={searchString}&state={state}&from={from}&to={to}&minTotal={minTotal}&maxTotal={maxTotal}	No documentation available.
GET api/estimates/{Id}	No documentation available.
GET api/estimates/{Id}/invoice	No documentation available.
PUT api/estimates/update	No documentation available.
POST api/estimates/{Id}/calculate	No documentation available.
DELETE api/estimates/{id}	No documentation available.