diff --git a/docs/8.0/ayanova/docs/adm-users.md b/docs/8.0/ayanova/docs/adm-users.md index 5608184b..a8e29adb 100644 --- a/docs/8.0/ayanova/docs/adm-users.md +++ b/docs/8.0/ayanova/docs/adm-users.md @@ -26,6 +26,12 @@ Users are accessed in the following ways: User accounts are used to grant access to AyaNova and also to track and schedule service technician and sub-contractor type Users known as "scheduleable users". +#### Controlling user access rights + +User access to the various features and business object types in AyaNova is controlled by a combination of the [User Type](#user-type) and the [authorization roles](ay-biz-admin-roles.md) settings for that User. + +For example if a user is set to a User type of Subcontractor they will not be able to see Part costs and prices no matter what their roles are. + #### Licensing and Scheduleable Users Only active, scheduleable type users consume a "service technician" license, see the [licensing page](adm-license.md#service-technician-scheduleable-users-and-licensing) for details. @@ -36,7 +42,7 @@ Scheduleable Users only appear in the [schedule form](svc-schedule.md) if they a #### Do not share User accounts -Every User of AyaNova **must** have their own account. +Every User of AyaNova **must** have their own account. AyaNova does _not_ support multiple simultaneous logins with the same User account; a fresh login automatically revokes prior logins so logging in as a User that is already logged in will kick out the originally logged in User. diff --git a/docs/8.0/ayanova/docs/api-intro.md b/docs/8.0/ayanova/docs/api-intro.md index a16f4779..485f9df3 100644 --- a/docs/8.0/ayanova/docs/api-intro.md +++ b/docs/8.0/ayanova/docs/api-intro.md @@ -1,7 +1,18 @@ # DEVELOPERS API -[under construction] +[UNDER CONSTRUCTION] +todo: update link from v7 to v8 specific development forum when it's available + +AyaNova features a RESTful API that can be used by developers to integrate their applications with AyaNova. + +The AyaNova user interface web application uses this same API for all access to AyaNova so it is possible by using the REST API to automate or integrate with anything that can be done in the AyaNova application. + +AyaNova comes with a [API explorer console](api-console.md) that can be used by developers to test and experiment with each API route without writing code and view the format of the data as well as documentation on the [API Request format](api-request-format.md), [API Response format](api-response-format.md) and [API Error codes](api-error-codes.md) table. + +In addition we have a [developers forum](https://forum.ayanova.com/c/ayanova-reporting-development/66) available for peer to peer and occasionally AyaNova development department response as time permits. + +Note that support for development integration (writing code) is beyond the scope of the technical support we provide, however any technical issues (problems) found with the API itself *are* available for support. + + -AyaNova features a REST API that can be used by developers to integrate with AyaNova. -todo: consolidate api api-error-codes / request / response / upload route stuff here into this document diff --git a/docs/8.0/ayanova/docs/api-request-format.md b/docs/8.0/ayanova/docs/api-request-format.md index ebea3920..a011a831 100644 --- a/docs/8.0/ayanova/docs/api-request-format.md +++ b/docs/8.0/ayanova/docs/api-request-format.md @@ -19,7 +19,7 @@ The [API explorer console](api-console.md) on your server is always the best sou ## Dates and times -All dates and times sent or retrieved from the REST interface **must** be ISO 8601 format in UTC / GMT time zone ONLY. For example, "2007-04-05T14:30Z" or "2007-04-05T14:30". The server does not expect dates to be in any other time zone or format. +All dates and times sent or retrieved from the REST interface **must** be ISO 8601 format in UTC / GMT time zone ONLY. For example, "2027-04-05T14:30Z" or "2027-04-05T14:30". The server does not expect dates to be in any other time zone or format. ## Translation diff --git a/docs/8.0/ayanova/docs/api-upload-routes.md b/docs/8.0/ayanova/docs/api-upload-routes.md index 43979c81..1f780bcf 100644 --- a/docs/8.0/ayanova/docs/api-upload-routes.md +++ b/docs/8.0/ayanova/docs/api-upload-routes.md @@ -4,75 +4,72 @@ AyaNova has several API routes for uploading files. These routes are all `POST` routes: -- `/api/v{version}/Attachment` -- `/api/v{version}/ImportAyaNova7` -- `/api/v{version}/Restore` +- `/api/v{version}/attachment` +- `/api/v{version}/import` +- `/api/v{version}/logo` -Upload routes are not testable from the API explorer. +Upload routes are not testable from the [API explorer console](api-console.md). Upload routes expect a form to be uploaded with file content disposition (multipart/form-data). -AyaNova will allow a maximum of 12gb per file upload for "Utility" routes such as restore and import routes. - -User file routes such as attachments may have a smaller limit, see the User documentation section for those features for limit details. +AyaNova limits the size of files uploaded to each of the upload routes documented in the [API explorer console](api-console.md) comments with those routes. Here is a sample minimal HTML form that works with AyaNova file routes: ```html - +
+ +