POST api/{programid}/UserDocument/Search

Request Information

URI Parameters

Name	Description	Type	Additional information
programid		string	Required

Body Parameters

SearchUserDocumentParams

Name	Type	Additional information
DocumentIds	Collection of integer	None.
Type	string	None.
ConsumerId	string	None.
ProviderId	string	None.
AuthId	string	None.
UserName	string	None.
InvoiceId	string	None.

Request Formats

application/json, text/json

Sample:

{
  "DocumentIds": [
    1,
    2
  ],
  "Type": "sample string 1",
  "ConsumerId": "sample string 2",
  "ProviderId": "sample string 3",
  "AuthId": "sample string 4",
  "UserName": "sample string 5",
  "InvoiceId": "sample string 6"
}

application/xml, text/xml

Sample:

<SearchUserDocumentParams xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPL.Services.WebApi.Models.CommonConfiguration">
  <AuthId>sample string 4</AuthId>
  <ConsumerId>sample string 2</ConsumerId>
  <DocumentIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </DocumentIds>
  <InvoiceId>sample string 6</InvoiceId>
  <ProviderId>sample string 3</ProviderId>
  <Type>sample string 1</Type>
  <UserName>sample string 5</UserName>
</SearchUserDocumentParams>

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

Response Information

Resource Description

Collection of UserDocument

Name	Type	Additional information
Id	integer	None.
Type	string	None.
ConsumerId	string	None.
ProviderId	string	None.
AuthorizationId	string	None.
InvoiceId	string	None.
FileLocation	string	None.
FileName	string	None.
UserName	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": 1,
    "Type": "sample string 2",
    "ConsumerId": "sample string 3",
    "ProviderId": "sample string 4",
    "AuthorizationId": "sample string 5",
    "InvoiceId": "sample string 6",
    "FileLocation": "sample string 7",
    "FileName": "sample string 8",
    "UserName": "sample string 9"
  },
  {
    "Id": 1,
    "Type": "sample string 2",
    "ConsumerId": "sample string 3",
    "ProviderId": "sample string 4",
    "AuthorizationId": "sample string 5",
    "InvoiceId": "sample string 6",
    "FileLocation": "sample string 7",
    "FileName": "sample string 8",
    "UserName": "sample string 9"
  }
]

application/xml, text/xml

Sample:

<ArrayOfUserDocument xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PPL.Services.Models.NavisionData.CommonClasses">
  <UserDocument>
    <AuthorizationId>sample string 5</AuthorizationId>
    <ConsumerId>sample string 3</ConsumerId>
    <FileLocation>sample string 7</FileLocation>
    <FileName>sample string 8</FileName>
    <Id>1</Id>
    <InvoiceId>sample string 6</InvoiceId>
    <ProviderId>sample string 4</ProviderId>
    <Type>sample string 2</Type>
    <UserName>sample string 9</UserName>
  </UserDocument>
  <UserDocument>
    <AuthorizationId>sample string 5</AuthorizationId>
    <ConsumerId>sample string 3</ConsumerId>
    <FileLocation>sample string 7</FileLocation>
    <FileName>sample string 8</FileName>
    <Id>1</Id>
    <InvoiceId>sample string 6</InvoiceId>
    <ProviderId>sample string 4</ProviderId>
    <Type>sample string 2</Type>
    <UserName>sample string 9</UserName>
  </UserDocument>
</ArrayOfUserDocument>