POST api/packages/documentsPackage

Creates a DocumentsPackageDTO. 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

DocumentsPackage

Name	Type	Additional information
DocumentsPackageId	integer	None.
PackageName	string	None.
LowerLimit	integer	None.
UpperLimit	integer	None.
Status	PackageStatus	None.

Response Formats

application/json, text/json

Sample:

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

text/html

Sample:

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

application/xml, text/xml

Sample:

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