PUT api/Edit/{name}?user={user}

Generic method for object editing

Request Information

URI Parameters

Name	Description	Type	Additional information
name	Name of object	string	Required
user	Optional user handle - if empty logged in user will be used	string	None.

Body Parameters

Edit details

Edit

Name	Description	Type	Additional information
IdList	List of ids to update or delete - empty for inserts	Collection of integer	Required
Data	List of data elements to modify/create	Dictionary of string [key] and string [value]	Required
Error	Details of error if edit fails	Error	None.
RowsAffected	Number of rows affected	integer	None.
NewId	Id of new object in case of insert	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "IdList": [
    1,
    2
  ],
  "Data": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "Error": {
    "Code": 1,
    "Detail": "sample string 2",
    "Data": {}
  },
  "RowsAffected": 1,
  "NewId": 2
}

application/xml, text/xml

Sample:

<Edit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models">
  <Data xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Data>
  <Error>
    <Code>1</Code>
    <Data />
    <Detail>sample string 2</Detail>
  </Error>
  <IdList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </IdList>
  <NewId>2</NewId>
  <RowsAffected>1</RowsAffected>
</Edit>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Edit object on success
Collection of errors on failure
Return codes
200 - ok
400 - bad request
401 - unauthorized
404 - not found
500 - internal server error

Edit

Name	Description	Type	Additional information
IdList	List of ids to update or delete - empty for inserts	Collection of integer	Required
Data	List of data elements to modify/create	Dictionary of string [key] and string [value]	Required
Error	Details of error if edit fails	Error	None.
RowsAffected	Number of rows affected	integer	None.
NewId	Id of new object in case of insert	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "IdList": [
    1,
    2
  ],
  "Data": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "Error": {
    "Code": 1,
    "Detail": "sample string 2",
    "Data": {}
  },
  "RowsAffected": 1,
  "NewId": 2
}

application/xml, text/xml

Sample:

<Edit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Namebay.Rest.Api.Models">
  <Data xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Data>
  <Error>
    <Code>1</Code>
    <Data />
    <Detail>sample string 2</Detail>
  </Error>
  <IdList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </IdList>
  <NewId>2</NewId>
  <RowsAffected>1</RowsAffected>
</Edit>