GET api/BackOffice

Receive request to get all backoffice accounts

Request Information

URI Parameters

None.

Body Parameters

authentication request object

ExternalServiceRequest
NameDescriptionTypeAdditional information
UserName

The provided user name.

 string

Required
Salt

A random number(at least 9 digits)

 integer

Required
Digest

A digest of the user credentials and the request

 string

Required

Request Formats

application/json, text/json

Sample: 
{
  "UserName": "sample string 1",
  "Salt": 2,
  "Digest": "sample string 3"
}

application/xml, text/xml

Sample: 
<ExternalServiceRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" UserName="sample string 1" Salt="2" Digest="sample string 3" />

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

accounts json object

GetAccountResponse
NameDescriptionTypeAdditional information
results

string

None.
Success

Indicate if the operation was success

 boolean

None.
Message

Return of errors or indicated return message/data

 string

None.
Extra1

Additional info 1 to return

 string

None.
Extra2

Additional info 2 to return

 string

None.
Extra3

Additional info 3 to return

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "results": "sample string 1",
  "Success": true,
  "Message": "sample string 3",
  "Extra1": "sample string 4",
  "Extra2": "sample string 5",
  "Extra3": "sample string 6"
}

application/xml, text/xml

Sample: 
<GetAccountResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Success>true</Success>
  <Message>sample string 3</Message>
  <Extra1>sample string 4</Extra1>
  <Extra2>sample string 5</Extra2>
  <Extra3>sample string 6</Extra3>
  <results>sample string 1</results>
</GetAccountResponse>