Standard Data Types

The following standard data types are used:

Used Object Models

The following models of objects are used in different methods:

Public API: PageV1Model [...]

Public API: PlanGetV1Model

Public API: PlanUpdateV1Model

Public API: CompanyV1Model

Public API: CompanyUpdateV1Model

Public API: AddressV1Model

Public API: AddressUpdateV1Model

Public API: ContactGetV1Model

Public API: ContactCreateV1Model

Public API: ContactAssignV1Model

Public API: ContactUpdateV1Model

Public API: LimitV1Model

Public API: LimitUpdateV1Model

Public API: AccountGetV1Model

Public API: AccountCreateV1Model

Public API: AccountGeneralV1Model

Public API: PaymentV1Model

Public API: PaymentCreditCardV1Model

Public API: PaymentGetV1Model

Public API: MsaV1Model

Public API: StateV1Model

Public API: UsageReportV1Model

Public API: Inline Model {}

Supported Request Content Types

The following request content types are supported:

Request and Response Structures

The request consists of:

  • CURL - you can view a request as a curl command (with authorization info and request data)
  • Request URL - each URL identifies a resource. It contains:
    • ID (identity) of the Account or Contact for whom the operation is performed (see parameter type - path in the method description);
    • parameters which define how to display the required information (e.g. how many items from the list to take, see parameter type - query in the method description)
  • Body - the request can optionally contain additional information in its body which might be required to perform the operation: for instance, data that you want to store with the resource. It contains the information that should be added, updated, etc. (see parameter type - body and requests examples in the method description)

Example of CURL CODE

curl -X GET --header 'Accept: application/json' --header 'Authorization: Bearer pxWzkDMWefrnA3ko10isSjWTorJ1K4rRh3U3XAkeA6rDDPdiQ3Ft35CH9aAG0-kX3oo-mEhaqjWXELZtNRyUXgT3-6H4BcHD0Ls02xPY17xkruneYgfm-xxRjwcBjIH8IPOzRlzwBg8gesVTW8X8rGnS3Ua_dVW3QsPNtw0q36jB-G-zeih-oD2jNm6gLwMzIMb293C_GTRS4V9jt-GzTWy3lN80d60-fVl_KqvNFIsPwjk4Ux0iQ6mVUf6S5Rf_wOZLisyojI80tHSfUenpjyrNjTmuErXWJjndQGRwsRUXR8f' 

The response includes:

  • Header - is the same for different responses (see example below)
  • Body - provides the requested information (see response examples in the method description)
  • Code - HTTP Status Code of the response (see link to Response Messages).

Example of Response Header CODE

"date": "Tue, 18 Apr 2017 07:03:07 GMT",
"server": "Microsoft-IIS/8.5",
"p3p": "policyref=\"/w3c/p3p.xml\", CP=\"NOI DSP CURa ADMa DEVa TAIa PSAa PSDa OUR IND UNI COM NAV\"",
"x-powered-by": "ASP.NET, ARR/2.5",
"content-type": "application/json; charset=utf-8",
"cache-control": "private",
"x-ratelimit-enabled": "false",
"content-length": "540"