Customer (Rest API) - Revision history

APIAdmin: /* Company contacts */

2019-06-05T21:24:29Z

‎Company contacts

Stev0560: /* v2 - Current */

2017-12-15T18:24:05Z

‎v2 - Current

Appscp: remove accept header from examples to avoid confusion

2017-01-12T21:50:49Z

remove accept header from examples to avoid confusion

Appscp at 15:38, 1 March 2016

2016-03-01T15:38:01Z

Appscp at 17:18, 5 January 2016

2016-01-05T17:18:06Z

Zach7981: Adding routes for company contacts, additional customer information fields

2015-11-17T20:21:10Z

Adding routes for company contacts, additional customer information fields

Show changes

Zach7981 at 17:21, 21 October 2015

2015-10-21T17:21:45Z

Show changes

Zach7981: Undo revision 698 by Zach7981 (talk)

2015-10-19T21:33:11Z

Undo revision 698 by Zach7981 (talk)

Zach7981: Added fields for customer information.

2015-10-19T21:32:38Z

Added fields for customer information.

Appscp: /* Index (Reseller Only) */

2015-04-02T15:59:44Z

‎Index (Reseller Only)

@@ Line 501: / Line 501: @@
-==== View contacts ====
+==== View contacts (Reseller Only) ====
 ''Description'':
@@ Line 538: / Line 538: @@
 </pre>
-===== Request parameters =====
+===== Request parameters (Reseller Only) =====
 - ''Size'': The number of contacts returned to GET requests. The default value is 50.
@@ Line 547: / Line 547: @@
-===== Alerts, Billing, and Updates =====
+===== Alerts, Billing, and Updates (Reseller Only) =====
 - ''ReceivesAlerts'': Indicates whether a contact receives account alerts.
@@ Line 556: / Line 556: @@
-===== View a specific contact =====
+===== View a specific contact (Reseller Only) =====
 ''Description'':
@@ Line 591: / Line 591: @@
-===== View a range of contacts at an offset =====
+===== View a range of contacts at an offset (Reseller Only) =====
 ''Description'':
@@ Line 641: / Line 641: @@
-==== Add a contact ====
+==== Add a contact (Reseller Only) ====
 ''Description'':
@@ Line 666: / Line 666: @@
-==== Update a contact ====
+==== Update a contact (Reseller Only) ====
 ''Description'':
@@ Line 696: / Line 696: @@
-==== Delete a contact ====
+==== Delete a contact (Reseller Only) ====
 ''Description'':

← Older revision		Revision as of 18:24, 15 December 2017
Line 413:		Line 413:

	== v2 - Current ==		== v2 - Current ==
		+
		+	=== Company Invoices ===
		+
		+	The paths in this section allow you to view a list of invoices, and download a CSV of the line items of a particular invoice.
		+
		+	==== View Invoices ====
		+
		+	''Description'':
		+
		+	View a list of invoices for an account in reverse chronological order (most recent first).
		+
		+
		+	''Request'':
		+
		+	<pre>
		+	GET '/v2/customers/999999/invoices', 'application/json'
		+	</pre>
		+
		+	''Response'':
		+
		+	<pre>
		+	200 OK
		+	{
		+	"Size": 50,
		+	"Offset": 0,
		+	"Total": 1,
		+	"Items": [{
		+	"InvoiceId": "123",
		+	"InvoiceDate": "2017-12-07T00:00:00",
		+	"InvoiceType": "Billing",
		+	"TotalDue": "1122.55",
		+	"IsPaid": true,
		+	"CsvAvailable": true
		+	}]
		+	}
		+	</pre>
		+
		+	===== Request parameters =====
		+
		+	- ''Size'': The number of invoices returned to GET requests. The default value is 50.
		+
		+	- ''Offset'': Indicates an offset at which to return invoices to GET requests. The default value is 0.
		+
		+	- ''Total'': Indicates the total number of invoices for the account.
		+
		+	===== CsvAvailable =====
		+
		+	If CsvAvailable is true, then you can use the CSV path (see just below) to retrieve a CSV of line items for this invoice.
		+
		+	==== Invoice Line Items ====
		+
		+	''Description'':
		+
		+	Download a CSV of line items for a specific invoice. You must pass a valid invoice ID in the path.
		+
		+
		+	''Request'':
		+
		+	<pre>
		+	GET '/v2/customers/999999/invoices/123123', 'application/json'
		+	</pre>
		+	Where 123123 is the invoice ID.
		+
		+	NOTE! The content-type returned for this route will always be 'text/csv'.
		+
		+	NOTE! CSV files are only available for invoices starting around July 2017. If a CSV is not available, this route will return a 404.
		+
		+	''Response'':
		+
		+	<pre>
		+	200 OK
		+	Account No,Reference No,Domain,Product,Type,Service Start,Service End,Term Committed Usage,Current Usage,Usage Change,Months,Rate,Charge
		+	1371592,"","MyDomain.com","Outlook",Renewal,12/1/2017 12:00:00 AM,12/31/2017 11:59:59 PM,20,20,20,1,0,0
		+	1371592,"","MyDomain.com","Hosted Exchange",Renewal,12/1/2017 12:00:00 AM,12/31/2017 11:59:59 PM,20,20,20,1,7,140
		+	1371592,"","MyDomain.com","Hosted Exchange ActiveSync",Renewal,12/1/2017 12:00:00 AM,12/31/2017 11:59:59 PM,20,20,20,1,0,0
		+	1371592,"","MyDomain.com","Hosted Exchange Extra Storage",Renewal,12/1/2017 12:00:00 AM,12/31/2017 11:59:59 PM,150,150,150,1,0,0
		+	1386010,"","MyOtherDomain","Office 365 Business Essentials",Renewal,12/1/2017 12:00:00 AM,12/31/2017 11:59:59 PM,31,31,31,1,7,217
		+	1386010,"","MyOtherDomain","Office 365 Business Essentials",Upgrade,11/6/2017 7:54:44 PM,11/30/2017 11:59:59 PM,29,31,2,0.81,7,11.34
		+	1386010,"","MyOtherDomain","Office 365 Business Premium",Renewal,12/1/2017 12:00:00 AM,12/31/2017 11:59:59 PM,39,39,39,1,14,546
		+	</pre>
		+
		+

	=== Company contacts ===		=== Company contacts ===

@@ Line 25: / Line 25: @@
 <pre>
-get '/customers?size=100&offset=10', 'text/xml'
+get '/customers?size=100&offset=10'
 </pre>
@@ Line 95: / Line 95: @@
 <pre>
-get '/customers/me', 'text/xml'
+get '/customers/me'
 </pre>
@@ Line 141: / Line 141: @@
 <pre>
-get '/customers?referenceNumber=49', 'text/xml'
+get '/customers?referenceNumber=49'
 </pre>
@@ Line 232: / Line 232: @@
 <pre>
-post '/customers', 'text/xml',
+post '/customers',
+{
   'name' => 'Name'
@@ Line 239: / Line 239: @@
 <pre>
-put '/customers/999999', 'text/xml',
+put '/customers/999999',
+{
    'name' => 'NewName',
@@ Line 338: / Line 338: @@
 <pre>
-delete '/customers/999999', 'text/xml'
+delete '/customers/999999'
 </pre>
@@ Line 376: / Line 376: @@
 <pre>
-post '/customers/460896/loginToken', {'userName' => 'dev_cust_limitedadmin', 'virtualUser' => 'true'}, 'text/xml'
+post '/customers/460896/loginToken', {'userName' => 'dev_cust_limitedadmin', 'virtualUser' => 'true'}
 </pre>

← Older revision		Revision as of 15:38, 1 March 2016
Line 84:		Line 84:
	To do the show operation on the account that is logged in instead of a customer's account, use "me" in the place of the customer account number i.e. <nowiki>'https://api.emailsrvr.com/v1/customers/me'</nowiki>.		To do the show operation on the account that is logged in instead of a customer's account, use "me" in the place of the customer account number i.e. <nowiki>'https://api.emailsrvr.com/v1/customers/me'</nowiki>.

−	The show operation only supports the GET HTTP verb. ~~For text/xml format, refer to the following schema document: [http://api.emailsrvr.com/Schemas/Customer.xsd Customer.xsd]~~	+	The show operation only supports the GET HTTP verb.

@@ Line 412: / Line 412: @@
 A customer can also use the login token to login on their private label control panel (E.g.: cp.mydomain.com/logintokens.aspx).
-== v2 - Coming soon ==
+== v2 - Current ==
 === Company contacts ===

@@ Line 72: / Line 72: @@
 {"name":"API Customer 50","accountNumber":"460183","referenceNumber":"10"}]}
 </pre>
 === Show (Reseller Only) ===
@@ Line 83: / Line 82: @@
 ''Description'':
-Returns detailed information about the specified account.
+The show operation will return detailed information about the specified account.
 ''Remarks'':
-To show detailed information for the account that is logged in instead of a customer's account, use "me" in the place of the customer account number. For example:
+To do the show operation on the account that is logged in instead of a customer's account, use "me" in the place of the customer account number i.e. <nowiki>'https://api.emailsrvr.com/v1/customers/me'</nowiki>.
 The show operation only supports the GET HTTP verb. For text/xml format, refer to the following schema document: [http://api.emailsrvr.com/Schemas/Customer.xsd Customer.xsd]
@@ Line 116: / Line 113: @@
    <accountNumber>460182</accountNumber>
    <referenceNumber>49</referenceNumber>
 </customer>
 </pre>
@@ Line 131: / Line 120: @@
 <pre>
 {"name":"API Customer 17","accountNumber":"460182","referenceNumber":"49"}
 </pre>
 ''Example of querying with Reference Number''
@@ Line 163: / Line 139: @@
    <accountNumber>460182</accountNumber>
    <referenceNumber>49</referenceNumber>
 </customer>
 </pre>

← Older revision		Revision as of 15:59, 2 April 2015
Line 19:		Line 19:
	''Filter/Search'':		''Filter/Search'':

−	Search parameter 'startswith' and 'contains' will try to find the result in customer name, account number and reference number. We also provide a separate query method ?referenceNumber=123456 that will return a Show on the exact customer whose reference number is as specified.	+	Search parameter 'startswith' and 'contains' will try to find the result in customer name, account number and reference number. We also provide a separate query method ?referenceNumber=123456 that will return a Show on the exact customer whose reference number is as specified. This query method only returns details for sub-accounts.