NetCard Server Web API

<back to all web services

KMGetDeviceByDeviceId

The following routes are available for this service:
GET/Device/KMGetDeviceByDeviceId/{DeviceId}/

To override the Content-type in your clients 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 /xml/reply/KMGetDeviceByDeviceId HTTP/1.1 
Host: ncapi.net.au 
Content-Type: application/xml
Content-Length: length

<KMGetDeviceByDeviceId xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NetCard.Server.API.ServiceModel.Device">
  <DeviceId>0</DeviceId>
</KMGetDeviceByDeviceId>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<KMGetDeviceByDeviceIdResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NetCard.Server.API.ServiceModel.Device">
  <ErrorCode xmlns="http://schemas.servicestack.net/types">String</ErrorCode>
  <Message xmlns="http://schemas.servicestack.net/types">String</Message>
  <StackTrace xmlns="http://schemas.servicestack.net/types">String</StackTrace>
  <Errors xmlns="http://schemas.servicestack.net/types">
    <ResponseError>
      <ErrorCode>String</ErrorCode>
      <FieldName>String</FieldName>
      <Message>String</Message>
    </ResponseError>
  </Errors>
  <Device xmlns:d2p1="http://schemas.datacontract.org/2004/07/NetCard.Server.API.DTO">
    <d2p1:AssetId>String</d2p1:AssetId>
    <d2p1:Cash>0</d2p1:Cash>
    <d2p1:ChildDeviceLocationId>0</d2p1:ChildDeviceLocationId>
    <d2p1:CurrentVersionDevice>0001-01-01T00:00:00</d2p1:CurrentVersionDevice>
    <d2p1:CustomerId>0</d2p1:CustomerId>
    <d2p1:DefaultTax>0</d2p1:DefaultTax>
    <d2p1:DeviceCode>String</d2p1:DeviceCode>
    <d2p1:DeviceId>0</d2p1:DeviceId>
    <d2p1:DeviceInventories i:nil="true" />
    <d2p1:DeviceLinkId>0</d2p1:DeviceLinkId>
    <d2p1:DeviceLocationId>0</d2p1:DeviceLocationId>
    <d2p1:DeviceTokenRegisterId>String</d2p1:DeviceTokenRegisterId>
    <d2p1:DeviceTypeId>0</d2p1:DeviceTypeId>
    <d2p1:IsDeleted>false</d2p1:IsDeleted>
    <d2p1:IsEnabled>false</d2p1:IsEnabled>
    <d2p1:LastSeen>0001-01-01T00:00:00</d2p1:LastSeen>
    <d2p1:LastUpdated>0001-01-01T00:00:00</d2p1:LastUpdated>
    <d2p1:LastVersion>String</d2p1:LastVersion>
    <d2p1:Name>String</d2p1:Name>
    <d2p1:Note>String</d2p1:Note>
    <d2p1:OpenFrom>PT0S</d2p1:OpenFrom>
    <d2p1:OpenTo>PT0S</d2p1:OpenTo>
    <d2p1:Password>String</d2p1:Password>
  </Device>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
      </d2p1:ResponseError>
    </d2p1:Errors>
  </ResponseStatus>
</KMGetDeviceByDeviceIdResponse>