Dealers API
V1
Parameters
Name | Description |
---|---|
body*required RequestsRequest (body) | ‘none’ |
Request body - instance of RequestsRequest
|
|
Name | Type | Required | Description |
---|---|---|---|
dealerId | integer | true | none |
platform | string | true | none |
issue | string | false | none |
requestType | string | true | none |
status | string | true | none |
requestDetail | any | false | none |
Name | Type | Required | Description |
---|---|---|---|
» anonymous | RequestDetailIamCreateDealer | false | none |
Name | Type | Required | Description |
---|---|---|---|
» anonymous | RequestDetailIamChangeCampaign | false | none |
Property | Values |
---|---|
platform | one of [JIRA, IAM] |
requestType | one of [DEALER_CREATION] |
status | one of [PENDING, CREATED, REJECTED, COMPLETED, ERROR] |
Request example
|
|
Responses
Code | Description | Schema |
---|---|---|
201 | Created. | RequestCreatedResponse |
400 | Bad request | ApiErrorResponse |
401 | Unauthorized | string |
500 | Internal Server Error | ApiErrorResponse |
Parameters
Name | Description |
---|---|
body*required array[integer] (body) | ‘none’ |
Request body - JsonObject
Request example
Responses
Code | Description | Schema |
---|---|---|
200 | No content. | None |
207 | Some request couldn’t be processed. | [RequestResponse] |
400 | Bad request | ApiErrorResponse |
401 | Unauthorized | string |
500 | Internal Server Error | ApiErrorResponse |
207 - instance of RequestResponse
Custom schema example
|
|
Name | Type | Required | Description |
---|---|---|---|
id | integer | false | none |
dealerId | integer | true | none |
dealerCode | string | false | none |
platform | string | true | none |
status | string | true | none |
userCreated | string | false | none |
creationDate | string | false | none |
requestDetails | object | false | none |
string | false | none | |
» orgUnit | string | false | none |
» salesRole | string | false | none |
» commercialProfile | [string] | false | none |
» simReplacement | boolean | false | none |
» eSIMReplacement | boolean | false | none |
Property | Values |
---|---|
platform | one of [JIRA, IAM] |
status | one of [PENDING, CREATED, REJECTED, COMPLETED, ERROR] |
400 - instance of ApiErrorResponse
Custom schema example
Name | Type | Required | Description |
---|---|---|---|
restErrors | [ApiError] | false | none |
401 - JsonObject
Name | Type | Required | Description |
---|---|---|---|
restErrors | [ApiError] | false | none |
500 - instance of ApiErrorResponse
Custom schema example
Name | Type | Required | Description |
---|---|---|---|
restErrors | [ApiError] | false | none |
Parameters
Name | Description |
---|---|
requestId*required integer (path) | ‘none’ |
body RequestModificationBody (body) | ‘none’ |
Request body - instance of RequestModificationBody
Name | Type | Required | Description |
---|---|---|---|
status | string | false | none |
comment | string | false | none |
Property | Values |
---|---|
status | one of [PENDING, CREATED, REJECTED, COMPLETED, ERROR] |
Request example
Responses
Code | Description | Schema |
---|---|---|
200 | Successful response. | None |
400 | Bad request | ApiErrorResponse |
401 | Unauthorized | string |
500 | Internal Server Error | ApiErrorResponse |
Endpoints
Default
- GET
/contacts/contacts
- POST
/contacts/contacts
- GET
/contacts/{contactId}/contacts/{contactId}
- PATCH
/contacts/{contactId}/contacts/{contactId}
- DELETE
/contacts/{contactId}/contacts/{contactId}
- DELETE
/contacts/{contactId}/dealers/{dealerId}/contacts/{contactId}/dealers/{dealerId}
- GET
/managers/managers
Dealer
- GET
/dealers/id/dealers/id
- GET
/dealers/{dealer_id}/dealers/{dealer_id}
- PATCH
/dealers/{dealer_id}/dealers/{dealer_id}
- DELETE
/dealers/{dealer_id}/dealers/{dealer_id}
- GET
/dealers/dealers
- POST
/dealers/dealers
- GET
/dealers/{dealer_id}/accounting-system/dealers/{dealer_id}/accounting-system
- GET
/dealers/full-info/{dealer_id}/dealers/full-info/{dealer_id}
- GET
/dealers/simple-list/dealers/simple-list
- GET
/dealers/{dealer_id}/contacts/dealers/{dealer_id}/contacts
- DELETE
/dealers/{dealer_id}/contacts/{contact_id}/dealers/{dealer_id}/contacts/{contact_id}
- POST
/dealers/contacts/dealers/contacts
- POST
/dealers/{dealer_id}/migration/dealers/{dealer_id}/migration
- GET
/dealers/{dealer_id}/migration/dealers/{dealer_id}/migration
- GET
/dealers/{dealer_id}/custom-information/dealers/{dealer_id}/custom-information
- POST
/dealers/custom-information/dealers/custom-information
- PATCH
/dealers/{dealer_id}/custom-information/{custom_info_id}/dealers/{dealer_id}/custom-information/{custom_info_id}
- DELETE
/dealers/{dealer_id}/custom-information/{custom_info_id}/dealers/{dealer_id}/custom-information/{custom_info_id}
- GET
/dealers/{dealer_id}/children/dealers/{dealer_id}/children
- POST
/dealers/{dealer_id}/block/dealers/{dealer_id}/block
- POST
/dealers/{dealer_id}/change-status/dealers/{dealer_id}/change-status
Fiscal data
- POST
/fiscal-data/fiscal-data
- GET
/fiscal-data/fiscal-data
- GET
/fiscal-data/{fiscal_data_id}/fiscal-data/{fiscal_data_id}
- PATCH
/fiscal-data/{fiscal_data_id}/fiscal-data/{fiscal_data_id}
- DELETE
/fiscal-data/{fiscal_data_id}/fiscal-data/{fiscal_data_id}
Custom information
- GET
/custom-information/custom-information
- POST
/custom-information/custom-information
- PATCH
/custom-information/{custom_info_id}/custom-information/{custom_info_id}
- DELETE
/custom-information/{custom_info_id}/custom-information/{custom_info_id}
Campaign
- POST
/campaigns/campaigns
- GET
/campaigns/{campaign_id}/campaigns/{campaign_id}
- PUT
/campaigns/{campaign_id}/campaigns/{campaign_id}
- POST
/campaigns/{campaign_id}/change-status/campaigns/{campaign_id}/change-status
- POST
/campaigns/search/campaigns/search
- GET
/campaigns/users/campaigns/users
- POST
/users/change-campaign/users/change-campaign
Subchannel
Store
Iam
Request