POST api/StorageObject/GetDocumentTypeInfo

Gets document type information for the given doctype

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
UserName		string	Required
SystemId		integer	Required
DocTypeCode		string	Required
LoadOnDemandComboValues		boolean	None.
Guid		string	None.
Vendor_Name	Vendor name in caps.	string	Required
Vendor_UserID	User ID of Vendor service account.	string	Required
Vendor_Password	Encrypted Password of vendor service account	string	Required

Request Formats

application/json, text/json, text/html

Sample:

{
  "UserName": "sample string 1",
  "SystemId": 2,
  "DocTypeCode": "sample string 3",
  "LoadOnDemandComboValues": true,
  "Guid": "sample string 5",
  "Vendor_Name": "sample string 6",
  "Vendor_UserID": "sample string 7",
  "Vendor_Password": "sample string 8"
}

application/xml, text/xml

Sample:

<GetDocTypeInfoExtRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NextGen.Digital.Imaging.App.ExtGateway.Models">
  <Vendor_Name>sample string 6</Vendor_Name>
  <Vendor_Password>sample string 8</Vendor_Password>
  <Vendor_UserID>sample string 7</Vendor_UserID>
  <DocTypeCode>sample string 3</DocTypeCode>
  <Guid>sample string 5</Guid>
  <LoadOnDemandComboValues>true</LoadOnDemandComboValues>
  <SystemId>2</SystemId>
  <UserName>sample string 1</UserName>
</GetDocTypeInfoExtRequest>

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 'GetDocTypeInfoExtRequest'.

multipart/form-data

Sample:

Failed to generate the sample for media type 'multipart/form-data'. Cannot use formatter 'DocumentCreationFormatter' to write type 'GetDocTypeInfoExtRequest'.

application/octet-stream

Sample:

Failed to generate the sample for media type 'application/octet-stream'. Cannot use formatter 'DocumentCreationFormatter' to write type 'GetDocTypeInfoExtRequest'.

Response Information

Resource Description

IVDocumentTypeDto

Name	Type	Additional information
Id	integer	None.
BusinessAreaId	integer	None.
BusinessAreaName	string	None.
Country	string	None.
SystemId	integer	None.
DocTypeName	string	None.
Status	boolean	None.
IndexingFields	Collection of Object	None.
DefaultStartingQueue	StartingQueue	None.
StartingQueueOptions	Collection of Object	None.

Response Formats

application/json, text/json, text/html

Sample:

{
  "Id": 1,
  "BusinessAreaId": 2,
  "BusinessAreaName": "sample string 3",
  "Country": "sample string 4",
  "SystemId": 5,
  "DocTypeName": "sample string 6",
  "Status": true,
  "IndexingFields": null,
  "DefaultStartingQueue": {
    "QueueId": 1,
    "QueueName": "sample string 2",
    "Validate": true
  },
  "StartingQueueOptions": null
}

application/xml, text/xml

Sample:

<IVDocumentTypeDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NextGen.Digital.Imaging.App.Gateway.EntityDataModels">
  <BusinessAreaId>2</BusinessAreaId>
  <BusinessAreaName>sample string 3</BusinessAreaName>
  <Country>sample string 4</Country>
  <DefaultStartingQueue>
    <QueueId>1</QueueId>
    <QueueName>sample string 2</QueueName>
    <Validate>true</Validate>
  </DefaultStartingQueue>
  <DocTypeName>sample string 6</DocTypeName>
  <Id>1</Id>
  <IndexingFields i:nil="true" />
  <StartingQueueOptions i:nil="true" />
  <Status>true</Status>
  <SystemId>5</SystemId>
</IVDocumentTypeDto>