POST public-api/sites/update

This method updates an existing site. The existing site is retrieved by calling API function GetSitesByName() or one of the searches. It requires the Edit Site permission and enforces Role Site restriction. TotalRecordsLongCount fields as not used by this API. It accepts a maximum of 500 records at a time.

Request Information

URI Parameters

None.

Body Parameters

Collection of SiteModelInfo

Name	Description	Type	Additional information
RowNumber	Optional. This is the ordinal position of the record in the given record set.	integer	None.
SiteName	Required. This is the unique site name.	string	None.
SiteDescription	Recommended. Indicates the site description.	string	None.
LocationCount	Read Only. This will returns the number of locations associated with this site.	integer	None.
SiteRecordStatus	Read-Only. Indicates whether the site is active or inactive.	RecordStatus	None.
SiteNotes	Optional. This is used to add a new note to a site.	string	None.
AccessAllCatgories	Optional. This is set to true if all categories are allowed at this site.	boolean	None.
AllSiteNotes	Read Only. This will contain a list of all notes associated with this site.	Collection of NoteInfo	None.
CustomFields	Retrieve or Specify values for custom fields.	Collection of DcfValueInfo	None.
AllowedCategories	Read Only. It is a list of categories that are allowed at this site. You will need to call a separate API to add or remove from this list.	Collection of string	None.

Request Formats

application/json

Sample:

[
  {
    "RowNumber": 0,
    "SiteName": "Front Office",
    "SiteDescription": "Description updated through api",
    "LocationCount": 0,
    "SiteRecordStatus": 1,
    "AccessAllCatgories": true,
    "AllSiteNotes": [],
    "CustomFields": [],
    "AllowedCategories": []
  }
]

Response Information

Resource Description

WaspResultOfResults

Name	Description	Type	Additional information
Data	Type specific result that always depends on the function called.	Results	None.
Messages	List of Messages. All APIs should return messages. If an API function returns an error you can find more information about the error or errors in this collection of messages.	Collection of WtResult	None.
BatchNumber	This is a global batch number generated by a mass group of transaction records to be returned to the consumer on each call to rolling transaction rules. This requests that each group of Move/Add/Remove transaction batches is tied together. In prior products (such as Mobile Asset Cloud), all are set to null and the only time when the batch number is generated is for multiple check-out transactions but the old is to generate for each responsible party.	integer	None.
HasError	True if an API function result has an error message in the results. If this is false, the function succeeded but other informative messages may be available.	boolean	None.
HasHttpError	True if an API function call could not be fully posted to the server or the results could not be fully returned.	boolean	None.
HasMessage	True if any message is available.	boolean	None.
HasSuccessWithMoreDataRemaining	True if the server sent part of the data and there is more data available. Use with paging APIs to fetch data one page at a time.	boolean	None.
TotalRecordsLongCount	This is the total number of records available in the database based on the query and filer conditions provided. It is possible that the value can change from call to call as users add and delete records so this should not be used to page through multiple recordsets of data. This is used, for example, to set relative scroll bar sizes. When paging through data using functions like the assetadvancedinfosearch, calculating TotalRecordsLongCount for every page full of data is an time-consuming operation. To avoid that extra calculation, and help prevent throttling, assign TotalRecordsLongCount to TotalCountFromPriorFetch in the AdvancedSearchParameters to skip recalculating this total page count and to page thru the records faster.	integer	None.

Response Formats

application/json

Sample:

{
  "Data": {
    "ResultList": [
      {
        "ResultCode": 0,
        "Message": "Success.",
        "HttpStatusCode": 200
      }
    ],
    "SuccessfullResults": 0,
    "TotalResults": 1
  },
  "Messages": [
    {
      "ResultCode": 0,
      "Message": "Success.",
      "HttpStatusCode": 200,
      "FieldName": ""
    }
  ],
  "HasSuccessWithMoreDataRemaining": false,
  "HasError": false,
  "HasMessage": true,
  "HasHttpError": false
}