PUT api/packages/documentsPackage

Updates e DocumentsPackage by its ID. THe new document package name must be unique.

Request Information

URI Parameters

None.

Body Parameters

Object to update or create.

Name	Description	Type	Additional information
DocumentsPackageId	Unique ID identifying the package.	integer	None.
PackageName	Unique name of the package.	string	None.
LowerLimit	Lower limit on the number of allowed sent documents, inclusively.	integer	None.
UpperLimit	Upper limit on the number of allowed sent documents, inclusively.	integer	None.
Status	"Active" or "Inactive". Inactive packages cannot be used for new subscriptions anymore.	string	None.

Request Formats

application/json, text/json

Sample:

{
  "DocumentsPackageId": 1,
  "PackageName": "sample string 2",
  "LowerLimit": 3,
  "UpperLimit": 4,
  "Status": "sample string 5"
}

text/html

Sample:

{"DocumentsPackageId":1,"PackageName":"sample string 2","LowerLimit":3,"UpperLimit":4,"Status":"sample string 5"}

application/xml, text/xml

Sample:

<DocumentsPackageDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Common.WebAPI.DTOs">
  <DocumentsPackageId>1</DocumentsPackageId>
  <LowerLimit>3</LowerLimit>
  <PackageName>sample string 2</PackageName>
  <Status>sample string 5</Status>
  <UpperLimit>4</UpperLimit>
</DocumentsPackageDTO>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'DocumentsPackageDTO'.

Response Information

Resource Description

Collection of DocumentsPackageDTO

Name	Description	Type	Additional information
DocumentsPackageId	Unique ID identifying the package.	integer	None.
PackageName	Unique name of the package.	string	None.
LowerLimit	Lower limit on the number of allowed sent documents, inclusively.	integer	None.
UpperLimit	Upper limit on the number of allowed sent documents, inclusively.	integer	None.
Status	"Active" or "Inactive". Inactive packages cannot be used for new subscriptions anymore.	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "DocumentsPackageId": 1,
    "PackageName": "sample string 2",
    "LowerLimit": 3,
    "UpperLimit": 4,
    "Status": "sample string 5"
  },
  {
    "DocumentsPackageId": 1,
    "PackageName": "sample string 2",
    "LowerLimit": 3,
    "UpperLimit": 4,
    "Status": "sample string 5"
  }
]

text/html

Sample:

[{"DocumentsPackageId":1,"PackageName":"sample string 2","LowerLimit":3,"UpperLimit":4,"Status":"sample string 5"},{"DocumentsPackageId":1,"PackageName":"sample string 2","LowerLimit":3,"UpperLimit":4,"Status":"sample string 5"}]

application/xml, text/xml

Sample:

<ArrayOfDocumentsPackageDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Common.WebAPI.DTOs">
  <DocumentsPackageDTO>
    <DocumentsPackageId>1</DocumentsPackageId>
    <LowerLimit>3</LowerLimit>
    <PackageName>sample string 2</PackageName>
    <Status>sample string 5</Status>
    <UpperLimit>4</UpperLimit>
  </DocumentsPackageDTO>
  <DocumentsPackageDTO>
    <DocumentsPackageId>1</DocumentsPackageId>
    <LowerLimit>3</LowerLimit>
    <PackageName>sample string 2</PackageName>
    <Status>sample string 5</Status>
    <UpperLimit>4</UpperLimit>
  </DocumentsPackageDTO>
</ArrayOfDocumentsPackageDTO>