PUT api/v1/articles/{articleId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
articleId

globally unique identifier

Required

Body Parameters

ArticleDetails
NameDescriptionTypeAdditional information
ArticleId

globally unique identifier

None.

ArticleNumber

string

Required

String length: inclusive between 0 and 50

ArticleName

string

Required

String length: inclusive between 0 and 250

ArticleInfo

string

String length: inclusive between 0 and 250

Description

string

None.

IsActive

boolean

Required

Id

globally unique identifier

None.

CanUpdateRecord

boolean

None.

CanDeleteRecord

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "ArticleId": "9b1889d8-ab92-4bae-b732-7597e56d4ca7",
  "ArticleNumber": "sample string 2",
  "ArticleName": "sample string 3",
  "ArticleInfo": "sample string 4",
  "Description": "sample string 5",
  "IsActive": true,
  "Id": "9b1889d8-ab92-4bae-b732-7597e56d4ca7",
  "CanUpdateRecord": true,
  "CanDeleteRecord": true
}

text/html

Sample:
{"ArticleId":"9b1889d8-ab92-4bae-b732-7597e56d4ca7","ArticleNumber":"sample string 2","ArticleName":"sample string 3","ArticleInfo":"sample string 4","Description":"sample string 5","IsActive":true,"Id":"9b1889d8-ab92-4bae-b732-7597e56d4ca7","CanUpdateRecord":true,"CanDeleteRecord":true}

application/xml, text/xml

Sample:
<ArticleDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi.Articles">
  <CanDeleteRecord xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi">true</CanDeleteRecord>
  <CanUpdateRecord xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi">true</CanUpdateRecord>
  <Id xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi">9b1889d8-ab92-4bae-b732-7597e56d4ca7</Id>
  <ArticleId>9b1889d8-ab92-4bae-b732-7597e56d4ca7</ArticleId>
  <ArticleInfo>sample string 4</ArticleInfo>
  <ArticleName>sample string 3</ArticleName>
  <ArticleNumber>sample string 2</ArticleNumber>
  <Description>sample string 5</Description>
  <IsActive>true</IsActive>
</ArticleDetails>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ArticleDetails
NameDescriptionTypeAdditional information
ArticleId

globally unique identifier

None.

ArticleNumber

string

Required

String length: inclusive between 0 and 50

ArticleName

string

Required

String length: inclusive between 0 and 250

ArticleInfo

string

String length: inclusive between 0 and 250

Description

string

None.

IsActive

boolean

Required

Id

globally unique identifier

None.

CanUpdateRecord

boolean

None.

CanDeleteRecord

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "ArticleId": "91c7b1e6-fb5d-4856-80ed-e1b05b95aa06",
  "ArticleNumber": "sample string 2",
  "ArticleName": "sample string 3",
  "ArticleInfo": "sample string 4",
  "Description": "sample string 5",
  "IsActive": true,
  "Id": "91c7b1e6-fb5d-4856-80ed-e1b05b95aa06",
  "CanUpdateRecord": true,
  "CanDeleteRecord": true
}

text/html

Sample:
{"ArticleId":"91c7b1e6-fb5d-4856-80ed-e1b05b95aa06","ArticleNumber":"sample string 2","ArticleName":"sample string 3","ArticleInfo":"sample string 4","Description":"sample string 5","IsActive":true,"Id":"91c7b1e6-fb5d-4856-80ed-e1b05b95aa06","CanUpdateRecord":true,"CanDeleteRecord":true}

application/xml, text/xml

Sample:
<ArticleDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi.Articles">
  <CanDeleteRecord xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi">true</CanDeleteRecord>
  <CanUpdateRecord xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi">true</CanUpdateRecord>
  <Id xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi">91c7b1e6-fb5d-4856-80ed-e1b05b95aa06</Id>
  <ArticleId>91c7b1e6-fb5d-4856-80ed-e1b05b95aa06</ArticleId>
  <ArticleInfo>sample string 4</ArticleInfo>
  <ArticleName>sample string 3</ArticleName>
  <ArticleNumber>sample string 2</ArticleNumber>
  <Description>sample string 5</Description>
  <IsActive>true</IsActive>
</ArticleDetails>