Octopus RPC / Customer Client

Octopus Store

Available Procedures

list() → Customer[]
listModifiedSince(dtISO8601) → Customer[]
query(options) → Customer[]
create(Customer) → id
retrieve(id) → Customer
update(Customer) → ra*
delete(id) → ra*

Notes

ra means records affected
Sometimes, depending on the database size, list() requests may timeout. If it happens, our advice is to proceed by paginating the result set with query(options) by a small amount, like 1000

Underlying Specs

Customer Definition

object { # | Ω(#) := "Customers"
	union {integer{1,}; null} "id";
	integer{1,} "idCatalog" = 1;

string{1,1} "userType" ["F", "J"] = "F";
	string{,50} "fullname" = "";
	string{1,1} "gender" ["M", "F"] = "M";
	string{10,19} "birthday" /^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2})?$/;

string{,20} "cpf_cnpj_passaporte" = "";
	string{,20} "rg_ie" = "";

string{,50} "company" = "" ?;
	string{,20} "department" = "" ?;
	string{,20} "occupation" = "" ?;

string{,50} "email" = "";
	string{,50} "telephone" = "";
	string{,50} "cellular_faxNumber" = "" ?;

string{,24} "password" = "" ?;

string{,100} "street" = "";
	string{,20} "number" = "";
	string{,50} "poBox" = "" ?;
	string{,50} "neighborhood" = "" ?;
	string{,50} "locality" = "";
	string{,50} "region" = "";
	string{,50} "country" = "";
	string{,8} "postalCode" = "";

string "notes" ?;
	string "privateNotes" ?;

string{10,19} "dtIns" /^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2})?$/ ?;
	string{10,19} "dtUpd" /^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2})?$/ ?;

boolean "active" = true;

array{
		object{
			string{,50} "id" = "";
			string{,50} "contact" = "";
			string{,100} "street" = "";
			string{,20} "number" = "";
			string{,50} "poBox" = "" ?;
			string{,50} "neighborhood" = "" ?;
			string{,50} "locality" = "";
			string{,50} "region" = "";
			string{,50} "country" = "";
			string{,8} "postalCode" = "";
		}
	} "shipping_addresses" = [] ?;

object{}* "custom_fields" ?;
}

Octopus RPC / Customer Client

Octopus Store

Available Procedures

Notes

Underlying Specs

Customer Definition

Options Definition

Request

Response