WebAPI

<back to all web services

GetAccount

Retrieves account settings and preferred methods of communication.

The following routes are available for this service:
GET/GetAccount/{AccountId}RESTFUL call with Account ID and Page Size in the URI
Parameters:
NameParameterData TypeRequiredDescription
AccountIdpathintYes

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/GetAccount HTTP/1.1 
Host: api-preprod.merseyflow.co.uk 
Content-Type: application/xml
Content-Length: length

<GetAccount xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.ServiceModel">
  <AccountId>0</AccountId>
</GetAccount>

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

<GetAccountsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.ServiceModel">
  <Account xmlns:d2p1="http://schemas.datacontract.org/2004/07/WebAPI.Models">
    <d2p1:AccountBalance>0</d2p1:AccountBalance>
    <d2p1:AccountId>0</d2p1:AccountId>
    <d2p1:AccountNumber>String</d2p1:AccountNumber>
    <d2p1:AccountStatementDelivery>String</d2p1:AccountStatementDelivery>
    <d2p1:AccountStatementDeliveryID>0</d2p1:AccountStatementDeliveryID>
    <d2p1:AccountStatus>String</d2p1:AccountStatus>
    <d2p1:AccountStatusID>0</d2p1:AccountStatusID>
    <d2p1:AccountType>String</d2p1:AccountType>
    <d2p1:AccountTypeId>0</d2p1:AccountTypeId>
    <d2p1:AddressInfos>
      <d2p1:AddressInfoFull>
        <d2p1:AddressId>0</d2p1:AddressId>
        <d2p1:AddressLine1>STRING</d2p1:AddressLine1>
        <d2p1:AddressLine2>STRING</d2p1:AddressLine2>
        <d2p1:AddressTypeId>0</d2p1:AddressTypeId>
        <d2p1:City>STRING</d2p1:City>
        <d2p1:ContactId>0</d2p1:ContactId>
        <d2p1:CountyCode>STRING</d2p1:CountyCode>
        <d2p1:PostalCode>STRING</d2p1:PostalCode>
        <d2p1:PtcAbsCode>STRING</d2p1:PtcAbsCode>
        <d2p1:AddressType>String</d2p1:AddressType>
        <d2p1:CountryCode>String</d2p1:CountryCode>
        <d2p1:IsPrimaryAddress>false</d2p1:IsPrimaryAddress>
      </d2p1:AddressInfoFull>
    </d2p1:AddressInfos>
    <d2p1:FinancialStatus>String</d2p1:FinancialStatus>
    <d2p1:FinancialStatusId>0</d2p1:FinancialStatusId>
    <d2p1:IsInGracePeriod>false</d2p1:IsInGracePeriod>
    <d2p1:IsMonthlyPassAutoRenewal>false</d2p1:IsMonthlyPassAutoRenewal>
    <d2p1:IsPostpaidAccount>false</d2p1:IsPostpaidAccount>
    <d2p1:LBTAmount>0</d2p1:LBTAmount>
    <d2p1:MobilePhone>String</d2p1:MobilePhone>
    <d2p1:PlanCode>String</d2p1:PlanCode>
    <d2p1:PrimaryContactId>0</d2p1:PrimaryContactId>
    <d2p1:RebillAmount>0</d2p1:RebillAmount>
    <d2p1:RebillMethod>String</d2p1:RebillMethod>
    <d2p1:RebillMethodId>0</d2p1:RebillMethodId>
  </Account>
  <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>
</GetAccountsResponse>