PecPaginatedListResponse

Successful response with a page of Pec

errorintegerrequired

Always 0 in a successful response

Constant value: 0

messagestring | nullnullablerequired

Always null in a successful response

data object[]required

Items of the page: an empty list beyond the last page

Array [

pec_idintegerrequired

purchase_idinteger | nullnullablerequired

Id of the purchase of the mailbox (GET /api/v3/purchases/{purchase_id})

purchase_namestring | nullnullablerequired

Name of the purchase object, as purchase_name.object_name of the purchase

purchase_status_codestring | nullnullablerequired

Status code of the purchase, for example ACTIVE_V2 or NEW_V2 (not active yet)

box_namestring | nullnullablerequired

Name of the mailbox, the part of the address before @; null until it is chosen

full_box_namestring | nullnullablerequired

Address of the mailbox (box_name@domain); empty until the name is chosen

domainstring | nullnullablerequired

report_emailstring | nullnullablerequired

Notification email for the PEC reports of the mailbox

report_smsstring | nullnullablerequired

Phone number that receives the SMS notifications of the mailbox; null when the SMS service is not active

password_recovery_emailstring | nullnullablerequired

Email used to recover the password of the mailbox

inbox_usagefloatnullablerequired

Space used in the inbox, in MB

archive_usagefloatnullablerequired

Space used in the archive, in MB

extra_inboxinteger | nullnullablerequired

Additional inbox space bought, in GB

extra_archiveinteger | nullnullablerequired

Additional archive space bought, in GB

transfer_inbooleanrequired

Whether the mailbox already existed and was transferred to us (incoming transfer)

owner_not_assignablebooleanrequired

Whether Aruba, the PEC provider, refused to assign the chosen owner to the mailbox during the activation

password_wrongbooleanrequired

Whether the password of the mailbox saved for the backups turned out wrong; the backups need the right one

]

meta objectrequired

Pagination of the list

totalintegerrequired

Number of items in the whole list

countintegerrequired

Number of items in this page: 0 beyond the last page

pagesintegerrequired

Number of pages of the list

pageintegerrequired

Number of this page, starting from 1

per_pageintegerrequired

Maximum number of items in a page

PecPaginatedListResponse

{
  "error": 0,
  "message": "string",
  "data": [
    {
      "pec_id": 0,
      "purchase_id": 0,
      "purchase_name": "string",
      "purchase_status_code": "string",
      "box_name": "string",
      "full_box_name": "string",
      "domain": "string",
      "report_email": "string",
      "report_sms": "string",
      "password_recovery_email": "string",
      "inbox_usage": 0,
      "archive_usage": 0,
      "extra_inbox": 0,
      "extra_archive": 0,
      "transfer_in": true,
      "owner_not_assignable": true,
      "password_wrong": true
    }
  ],
  "meta": {
    "total": 0,
    "count": 0,
    "pages": 0,
    "page": 0,
    "per_page": 0
  }
}