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 .jsv suffix or ?format=jsv

HTTP + JSV

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

POST /jsv/reply/GetAccount HTTP/1.1 
Host: api-preprod.merseyflow.co.uk 
Content-Type: text/jsv
Content-Length: length

{
	AccountId: 0
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Account: 
	{
		AccountId: 0,
		AccountNumber: String,
		PrimaryContactId: 0,
		AccountStatementDeliveryID: 0,
		AccountStatementDelivery: String,
		AccountType: String,
		AccountTypeId: 0,
		AccountBalance: 0,
		AccountStatusID: 0,
		AccountStatus: String,
		FinancialStatusId: 0,
		FinancialStatus: String,
		IsInGracePeriod: False,
		MobilePhone: String,
		AddressInfos: 
		[
			{
				AddressType: String,
				CountryCode: String,
				IsPrimaryAddress: False,
				AddressTypeId: 0,
				AddressLine1: STRING,
				AddressLine2: STRING,
				City: STRING,
				CountyCode: STRING,
				PostalCode: STRING,
				PtcAbsCode: STRING,
				ContactId: 0,
				AddressId: 0
			}
		],
		RebillAmount: 0,
		LBTAmount: 0,
		IsPostpaidAccount: False,
		PlanCode: String,
		RebillMethodId: 0,
		RebillMethod: String,
		IsMonthlyPassAutoRenewal: False
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String
			}
		]
	}
}