1Fetch Client API

CheckAccount

The following routes are available for this service:
GET	/checkaccount	Check account limit and remaining account amount

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports WebService.ClientServiceModel
Imports WebService.ClientServiceModel.Base

Namespace Global

    Namespace WebService.ClientServiceModel

        Public Partial Class CheckAccount
            Inherits ApiServiceRequest
            Implements ILogRequest
        End Class

        Public Partial Class CheckAccountResponse
            Inherits ApiServiceResponse
            '''<Summary>
            '''The total monthly limit for account payments, will be negative if there is no limit
            '''</Summary>
            <ApiMember(Description:="The total monthly limit for account payments, will be negative if there is no limit")>
            Public Overridable Property AccountLimit As Decimal

            '''<Summary>
            '''The amount that can still be used this month, will be negative if there is no account limit
            '''</Summary>
            <ApiMember(Description:="The amount that can still be used this month, will be negative if there is no account limit")>
            Public Overridable Property AccountRemaining As Decimal

            '''<Summary>
            '''Shows if this account is allowed to place real orders or quotes
            '''</Summary>
            <ApiMember(Description:="Shows if this account is allowed to place real orders or quotes")>
            Public Overridable Property AllowDataProcessing As Boolean
        End Class
    End Namespace

    Namespace WebService.ClientServiceModel.Base

        Public Partial Class ApiServiceRequest
            Implements IServiceRequest
            Implements IHasApiKey
            '''<Summary>
            '''The API Key required for authentication
            '''</Summary>
            <ApiMember(DataType:="string", Description:="The API Key required for authentication", IsRequired:=true)>
            Public Overridable Property ApiKey As String
        End Class

        Public Partial Class ApiServiceResponse
            Implements IServiceResponse
            '''<Summary>
            '''Information about the response.
            '''</Summary>
            <ApiMember(Description:="Information about the response.", IsRequired:=true)>
            Public Overridable Property Description As String

            '''<Summary>
            '''Heading or summary of the response.
            '''</Summary>
            <ApiMember(Description:="Heading or summary of the response.", IsRequired:=true)>
            Public Overridable Property Heading As String

            '''<Summary>
            '''Did the intended operation for this response complete successfully?
            '''</Summary>
            <ApiMember(DataType:="boolean", Description:="Did the intended operation for this response complete successfully?", IsRequired:=true)>
            Public Overridable Property WasSuccessful As Boolean
        End Class
    End Namespace
End Namespace

VB.NET CheckAccount DTOs

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.

GET /checkaccount HTTP/1.1 
Host: api.1fetch.co.za 
Accept: application/xml

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

<CheckAccountResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientServiceModel">
  <Description xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientServiceModel.Base">String</Description>
  <Heading xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientServiceModel.Base">String</Heading>
  <WasSuccessful xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientServiceModel.Base">false</WasSuccessful>
  <AccountLimit>0</AccountLimit>
  <AccountRemaining>0</AccountRemaining>
  <AllowDataProcessing>false</AllowDataProcessing>
</CheckAccountResponse>