Address
GET /api/clients/address
Fields
Field | Type | Description | Required |
---|---|---|---|
state | NO | ||
country | NO | ||
locality | NO | ||
profile | NO | ||
checksum | NO | ||
type | NO | ||
postcode | NO | ||
streetPrefix | NO | ||
quarter | NO | ||
street | NO | ||
house | NO | ||
block | NO | ||
apartment | NO | ||
quarter | NO | ||
notFormal | NO | ||
geo | NO | ||
floor | NO | ||
entrance | NO | ||
extId | NO | ||
owner | NO |
Request
Headers
Header | Value |
---|---|
Accept | |
Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 401: Unauthorized
- 403: Forbidden
Headers
Header | Value |
---|---|
Content-Type | |
Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/clients/address
Fields
Field | Type | Description | Required |
---|---|---|---|
state | NO | ||
country | NO | ||
locality | NO | ||
profile | NO | ||
checksum | NO | ||
type | NO | ||
postcode | NO | ||
streetPrefix | NO | ||
quarter | NO | ||
street | NO | ||
house | NO | ||
block | NO | ||
apartment | NO | ||
quarter | NO | ||
notFormal | NO | ||
geo | NO | ||
floor | NO | ||
entrance | NO | ||
extId | NO | ||
owner | NO |
Request
Headers
Header | Value |
---|---|
Accept | |
Content-Type | |
Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
Header | Value |
---|---|
Content-Type | |
Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /api/clients/address
Fields
Field | Type | Description | Required |
---|---|---|---|
state | NO | ||
country | NO | ||
locality | NO | ||
profile | NO | ||
checksum | NO | ||
type | NO | ||
postcode | NO | ||
streetPrefix | NO | ||
quarter | NO | ||
street | NO | ||
house | NO | ||
block | NO | ||
apartment | NO | ||
quarter | NO | ||
notFormal | NO | ||
geo | NO | ||
floor | NO | ||
entrance | NO | ||
extId | NO | ||
owner | NO |
Request
Headers
Header | Value |
---|---|
Accept | |
Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 401: Unauthorized
- 403: Forbidden
Headers
Header | Value |
---|---|
Content-Type | |
Allow | Comma-separated list of all HTTP methods allowed |
GET /api/clients/address[/:address_id]
Fields
Field | Type | Description | Required |
---|---|---|---|
state | NO | ||
country | NO | ||
locality | NO | ||
profile | NO | ||
checksum | NO | ||
type | NO | ||
postcode | NO | ||
streetPrefix | NO | ||
quarter | NO | ||
street | NO | ||
house | NO | ||
block | NO | ||
apartment | NO | ||
quarter | NO | ||
notFormal | NO | ||
geo | NO | ||
floor | NO | ||
entrance | NO | ||
extId | NO | ||
owner | NO |
Request
Headers
Header | Value |
---|---|
Accept | |
Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
Header | Value |
---|---|
Content-Type | |
Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/clients/address[/:address_id]
Fields
Field | Type | Description | Required |
---|---|---|---|
state | NO | ||
country | NO | ||
locality | NO | ||
profile | NO | ||
checksum | NO | ||
type | NO | ||
postcode | NO | ||
streetPrefix | NO | ||
quarter | NO | ||
street | NO | ||
house | NO | ||
block | NO | ||
apartment | NO | ||
quarter | NO | ||
notFormal | NO | ||
geo | NO | ||
floor | NO | ||
entrance | NO | ||
extId | NO | ||
owner | NO |
Request
Headers
Header | Value |
---|---|
Accept | |
Content-Type | |
Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
Header | Value |
---|---|
Content-Type | |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Phone
Phones
GET /api/clients/phone
Fields
Field | Type | Description | Required |
---|---|---|---|
state | NO | ||
phone | NO | ||
country | YES |
Request
Headers
Header | Value |
---|---|
Accept | |
Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 401: Unauthorized
- 403: Forbidden
Headers
Header | Value |
---|---|
Content-Type | |
Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/clients/phone
Fields
Field | Type | Description | Required |
---|---|---|---|
state | NO | ||
phone | NO | ||
country | YES |
Request
Headers
Header | Value |
---|---|
Accept | |
Content-Type | |
Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
Header | Value |
---|---|
Content-Type | |
Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /api/clients/phone[/:phone_id]
Fields
Field | Type | Description | Required |
---|---|---|---|
state | NO | ||
phone | NO | ||
country | YES |
Request
Headers
Header | Value |
---|---|
Accept | |
Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
Header | Value |
---|---|
Content-Type | |
Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/clients/phone[/:phone_id]
Fields
Field | Type | Description | Required |
---|---|---|---|
state | NO | ||
phone | NO | ||
country | YES |
Request
Headers
Header | Value |
---|---|
Accept | |
Content-Type | |
Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
Header | Value |
---|---|
Content-Type | |
Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /api/clients/phone[/:phone_id]
Fields
Field | Type | Description | Required |
---|---|---|---|
state | NO | ||
phone | NO | ||
country | YES |
Request
Headers
Header | Value |
---|---|
Accept | |
Content-Type | |
Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
Header | Value |
---|---|
Content-Type | |
Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /api/clients/phone[/:phone_id]
Fields
Field | Type | Description | Required |
---|---|---|---|
state | NO | ||
phone | NO | ||
country | YES |
Request
Headers
Header | Value |
---|---|
Accept | |
Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
Header | Value |
---|---|
Content-Type | |
Allow | Comma-separated list of all HTTP methods allowed |
POST /api/clients/phone[/:phone_id]
Fields
Field | Type | Description | Required |
---|---|---|---|
state | NO | ||
phone | NO | ||
country | YES |
Request
Headers
Header | Value |
---|---|
Accept | |
Content-Type | |
Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
Header | Value |
---|---|
Content-Type | |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Profile
Profiles
GET /api/clients/profile
Fields
Field | Type | Description | Required |
---|---|---|---|
name/name | YES |
Request
Headers
Header | Value |
---|---|
Accept | |
Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 401: Unauthorized
- 403: Forbidden
Headers
Header | Value |
---|---|
Content-Type | |
Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/clients/profile
Fields
Field | Type | Description | Required |
---|---|---|---|
name/name | YES |
Request
Headers
Header | Value |
---|---|
Accept | |
Content-Type | |
Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
Header | Value |
---|---|
Content-Type | |
Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /api/clients/profile[/:profile_id]
Fields
Field | Type | Description | Required |
---|---|---|---|
name/name | YES |
Request
Headers
Header | Value |
---|---|
Accept | |
Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
Header | Value |
---|---|
Content-Type | |
Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/clients/profile[/:profile_id]
Fields
Field | Type | Description | Required |
---|---|---|---|
name/name | YES |
Request
Headers
Header | Value |
---|---|
Accept | |
Content-Type | |
Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
Header | Value |
---|---|
Content-Type | |
Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/clients/profile[/:profile_id]
Fields
Field | Type | Description | Required |
---|---|---|---|
name/name | YES |
Request
Headers
Header | Value |
---|---|
Accept | |
Content-Type | |
Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
Header | Value |
---|---|
Content-Type | |
Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /api/clients/profile[/:profile_id]
Fields
Field | Type | Description | Required |
---|---|---|---|
name/name | YES |
Request
Headers
Header | Value |
---|---|
Accept | |
Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
Header | Value |
---|---|
Content-Type | |
Allow | Comma-separated list of all HTTP methods allowed |