Needio.Services.ExtApiHost

<back to all web services

ExtGetSmAttributeDefsRequest

The following routes are available for this service:
All Verbs/Ext/GetSmAttributeDefs/
ExtGetSmAttributeDefsRequest Parameters:
NameParameterData TypeRequiredDescription
PostTypeIdqueryintNo
ModifiedSincequeryDateTime?No
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
startformDateTimeNo
DeviceUUIDformstringNo
APIKeyformstringNo
isAdminformboolNo
CmdformstringNo
ExtGetSmAttributeDefsResponse Parameters:
NameParameterData TypeRequiredDescription
AttibuteDefsformList<SmAttributeDefExtDTO>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
ResMessageformstringNo
ErrorformErrorNo
PageInfoformBasePageInfoNo
Error Parameters:
NameParameterData TypeRequiredDescription
ErrorYnformboolNo
ExYnformboolNo
ErrorCodeformstringNo
ErrorDescriptionformstringNo
BasePageInfo Parameters:
NameParameterData TypeRequiredDescription
TotalRecordCountformintNo
TotalPageCountformintNo
CurrentPageformintNo
SmAttributeDefExtDTO Parameters:
NameParameterData TypeRequiredDescription
ATypeformSmAttributeTypesNo
CodeformstringNo
AttributeDatasformList<SmAttributeDataDTO>No
MinValueformintNo
MaxValueformintNo
SmAttributeInfoDTO Parameters:
NameParameterData TypeRequiredDescription
AttributeDefIdformshortNo
NameformstringNo
LabelTextformstringNo
RequiredformboolNo
ATypeformSmAttributeTypesNo
DefaultKeyformstringNo
DefaultValueformstringNo
MinValueformint?No
MaxValueformint?No
SmAttributeTypes Enum:
NameValue
Text1
Number2
Combo11
MultiSelect12
State13
Brand21
SmAttributeDataDTO Parameters:
NameParameterData TypeRequiredDescription
KeyformstringNo
ValueformstringNo
CountformintNo
OrderformintNo
ExtGetSmAttributeDefsResponse Parameters:
NameParameterData TypeRequiredDescription
AttibuteDefsformList<SmAttributeDefExtDTO>No

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 /Ext/GetSmAttributeDefs/ HTTP/1.1 
Host: apiservices.needion.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ExtGetSmAttributeDefsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2">
  <APIKey>String</APIKey>
  <Cmd>String</Cmd>
  <DeviceUUID>String</DeviceUUID>
  <isAdmin>false</isAdmin>
  <start>0001-01-01T00:00:00</start>
  <ModifiedSince>0001-01-01T00:00:00</ModifiedSince>
  <PostTypeId>0</PostTypeId>
</ExtGetSmAttributeDefsRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ExtGetSmAttributeDefsResponse 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>
    <ExYn>false</ExYn>
  </Error>
  <PageInfo>
    <CurrentPage>0</CurrentPage>
    <TotalPageCount>0</TotalPageCount>
    <TotalRecordCount>0</TotalRecordCount>
  </PageInfo>
  <ResMessage>String</ResMessage>
  <Result>false</Result>
  <AttibuteDefs xmlns:d2p1="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2.Models">
    <d2p1:SmAttributeDefExtDTO>
      <d2p1:AType>Combo</d2p1:AType>
      <d2p1:AttributeDefId>0</d2p1:AttributeDefId>
      <d2p1:DefaultKey>String</d2p1:DefaultKey>
      <d2p1:DefaultValue>String</d2p1:DefaultValue>
      <d2p1:LabelText>String</d2p1:LabelText>
      <d2p1:MaxValue>0</d2p1:MaxValue>
      <d2p1:MinValue>0</d2p1:MinValue>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:Required>false</d2p1:Required>
      <d2p1:AType>Text</d2p1:AType>
      <d2p1:AttributeDatas>
        <d2p1:SmAttributeDataDTO>
          <d2p1:Count>0</d2p1:Count>
          <d2p1:Key>String</d2p1:Key>
          <d2p1:Order>0</d2p1:Order>
          <d2p1:Value>String</d2p1:Value>
        </d2p1:SmAttributeDataDTO>
      </d2p1:AttributeDatas>
      <d2p1:Code>String</d2p1:Code>
      <d2p1:MaxValue>0</d2p1:MaxValue>
      <d2p1:MinValue>0</d2p1:MinValue>
    </d2p1:SmAttributeDefExtDTO>
  </AttibuteDefs>
</ExtGetSmAttributeDefsResponse>