PUT api/portal/Sites

Update Site records.

Request Information

URI Parameters

None.

Body Parameters

IBMS_Cloud_API.SiteModel+SiteFields
NameDescriptionTypeAdditional information
SiteID

integer

None.

ClientID

string

None.

SiteName

string

None.

Reference

string

None.

ActiveStatus

boolean

None.

AddressLine1

string

None.

AddressLine2

string

None.

AddressLine3

string

None.

County

string

None.

CityTown

string

None.

Postcode

string

None.

PhoneNumber

string

None.

Email

string

None.

ClientName

string

None.

ClientReference

string

None.

StatusLabel

string

None.

ImageString

string

None.

ContactName

string

None.

Request Formats

application/json, text/json

Sample:
{
  "SiteID": 1,
  "ClientID": "sample string 2",
  "SiteName": "sample string 3",
  "Reference": "sample string 4",
  "ActiveStatus": true,
  "AddressLine1": "sample string 6",
  "AddressLine2": "sample string 7",
  "AddressLine3": "sample string 8",
  "County": "sample string 9",
  "CityTown": "sample string 10",
  "Postcode": "sample string 11",
  "PhoneNumber": "sample string 12",
  "Email": "sample string 13",
  "ClientName": "sample string 14",
  "ClientReference": "sample string 15",
  "StatusLabel": "sample string 16",
  "ImageString": "sample string 17",
  "ContactName": "sample string 18"
}

text/html

Sample:
{"SiteID":1,"ClientID":"sample string 2","SiteName":"sample string 3","Reference":"sample string 4","ActiveStatus":true,"AddressLine1":"sample string 6","AddressLine2":"sample string 7","AddressLine3":"sample string 8","County":"sample string 9","CityTown":"sample string 10","Postcode":"sample string 11","PhoneNumber":"sample string 12","Email":"sample string 13","ClientName":"sample string 14","ClientReference":"sample string 15","StatusLabel":"sample string 16","ImageString":"sample string 17","ContactName":"sample string 18"}

application/xml, text/xml

Sample:
<SiteModel.SiteFields xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IBMS_Cloud_API">
  <ActiveStatus>true</ActiveStatus>
  <AddressLine1>sample string 6</AddressLine1>
  <AddressLine2>sample string 7</AddressLine2>
  <AddressLine3>sample string 8</AddressLine3>
  <CityTown>sample string 10</CityTown>
  <ClientID>sample string 2</ClientID>
  <ClientName>sample string 14</ClientName>
  <ClientReference>sample string 15</ClientReference>
  <ContactName>sample string 18</ContactName>
  <County>sample string 9</County>
  <Email>sample string 13</Email>
  <ImageString>sample string 17</ImageString>
  <PhoneNumber>sample string 12</PhoneNumber>
  <Postcode>sample string 11</Postcode>
  <Reference>sample string 4</Reference>
  <SiteID>1</SiteID>
  <SiteName>sample string 3</SiteName>
  <StatusLabel>sample string 16</StatusLabel>
</SiteModel.SiteFields>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IBMS_Cloud_API.Output+Outputs
NameDescriptionTypeAdditional information
ID

string

None.

Successful

boolean

None.

Details

string

None.

Response Formats

application/json, text/json

Sample:
{
  "ID": "sample string 1",
  "Successful": true,
  "Details": "sample string 3"
}

text/html

Sample:
{"ID":"sample string 1","Successful":true,"Details":"sample string 3"}

application/xml, text/xml

Sample:
<Output.Outputs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IBMS_Cloud_API">
  <Details>sample string 3</Details>
  <ID>sample string 1</ID>
  <Successful>true</Successful>
</Output.Outputs>