Needio.Services

<back to all web services

GetStaticDocumentRequest

The following routes are available for this service:
All Verbs/GetStaticDocument/
GetStaticDocumentRequest Parameters:
NameParameterData TypeRequiredDescription
DocumentTypequeryDocumentTypeNo
ParameterListqueryList<NameValue>No
RelatedIdqueryintNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
startformDateTimeNo
DeviceUUIDformstringNo
APIKeyformstringNo
GetStaticDocumentResponse Parameters:
NameParameterData TypeRequiredDescription
DocumentStringformstringNo
RelatedIdformintNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
ResMessageformstringNo
ErrorformErrorNo
PageInfoformBasePageInfoNo
Error Parameters:
NameParameterData TypeRequiredDescription
ErrorYnformboolNo
ErrorCodeformstringNo
ErrorDescriptionformstringNo
BasePageInfo Parameters:
NameParameterData TypeRequiredDescription
TotalRecordCountformintNo
TotalPageCountformintNo
CurrentPageformintNo
DocumentType Enum:
NameValue
MembershipAgreement1
CommercialElectronicMessageConditions2
GDPR3
SellerAgreement4
PersonalDataDisclosure5
ProductCommentInfoText6
ContinueWithoutMember7
HowDoSellSupport8
SupportInfo9
SendMessageDocument10
NameValue Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
ValueformObjectNo
GetStaticDocumentResponse Parameters:
NameParameterData TypeRequiredDescription
DocumentStringformstringNo
RelatedIdformintNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /GetStaticDocument/ HTTP/1.1 
Host: baseservices.needion.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetStaticDocumentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2">
  <APIKey>String</APIKey>
  <DeviceUUID>String</DeviceUUID>
  <DocumentType>MembershipAgreement</DocumentType>
  <ParameterList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2.Models">
    <d2p1:NameValue>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:Value />
    </d2p1:NameValue>
  </ParameterList>
  <RelatedId>0</RelatedId>
</GetStaticDocumentRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetStaticDocumentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2">
  <Error>
    <ErrorCode>String</ErrorCode>
    <ErrorDescription>String</ErrorDescription>
    <ErrorYn>false</ErrorYn>
  </Error>
  <PageInfo>
    <CurrentPage>0</CurrentPage>
    <TotalPageCount>0</TotalPageCount>
    <TotalRecordCount>0</TotalRecordCount>
  </PageInfo>
  <ResMessage>String</ResMessage>
  <Result>false</Result>
  <DocumentString>String</DocumentString>
  <RelatedId>0</RelatedId>
</GetStaticDocumentResponse>