diff --git a/site/specs/numbers.yml b/site/specs/numbers.yml index bd154aab0..732dc6037 100644 --- a/site/specs/numbers.yml +++ b/site/specs/numbers.yml @@ -242,7 +242,7 @@ components: - Campaign404Error: + Campaign403Error: value: |- @@ -646,6 +646,14 @@ components: required: true schema: type: string + CampaignIdPathParam: + description: User's campaign ID + example: CBA001 + in: path + name: campaignId + required: true + schema: + type: string DomainNamePathParam: description: Domain name example: dashboard @@ -2845,6 +2853,11 @@ components: maxLength: 50 title: CallerName type: string + CampaignErrorResponse: + properties: + CampaignErrorResponse: + $ref: '#/components/schemas/ResponseStatus' + type: object CampaignRequest: properties: Campaign: @@ -16494,8 +16507,10 @@ paths: application/xml: examples: example: - $ref: '#/components/examples/Campaign404Error' + $ref: '#/components/examples/CampaignNotFound404Error' description: example + schema: + $ref: '#/components/schemas/CampaignErrorResponse' description: Not Found summary: Fetch Campaign List tags: @@ -16530,6 +16545,8 @@ paths: example: $ref: '#/components/examples/CreateCampaign400Error' description: example + schema: + $ref: '#/components/schemas/CampaignErrorResponse' description: Bad Request summary: Create Campaign tags: @@ -16627,13 +16644,7 @@ paths: operationId: GetImportedCampaign parameters: - $ref: '#/components/parameters/AccountIdPathParam' - - description: The campaign id. - example: CA114BN - in: path - name: campaignId - required: true - schema: - type: string + - $ref: '#/components/parameters/CampaignIdPathParam' responses: '200': content: @@ -16664,14 +16675,7 @@ paths: operationId: deleteCampaign parameters: - $ref: '#/components/parameters/AccountIdPathParam' - - description: campaign ID - example: null - in: path - name: campaignId - required: true - schema: - default: null - type: string + - $ref: '#/components/parameters/CampaignIdPathParam' responses: '204': description: No Content @@ -16680,8 +16684,10 @@ paths: application/xml: examples: example: - $ref: '#/components/examples/Campaign404Error' + $ref: '#/components/examples/Campaign403Error' description: example + schema: + $ref: '#/components/schemas/CampaignErrorResponse' description: Forbidden '404': content: @@ -16690,6 +16696,8 @@ paths: example: $ref: '#/components/examples/CampaignNotFound404Error' description: example + schema: + $ref: '#/components/schemas/CampaignErrorResponse' description: Not Found summary: Delete Campaign tags: @@ -16699,14 +16707,7 @@ paths: operationId: fetchCampaign parameters: - $ref: '#/components/parameters/AccountIdPathParam' - - description: '' - example: null - in: path - name: campaignId - required: true - schema: - default: null - type: string + - $ref: '#/components/parameters/CampaignIdPathParam' responses: '200': content: @@ -16723,6 +16724,8 @@ paths: example: $ref: '#/components/examples/CampaignNotFound404Error' description: example + schema: + $ref: '#/components/schemas/CampaignErrorResponse' description: Not Found summary: Fetch Campaign tags: @@ -16757,10 +16760,47 @@ paths: example: $ref: '#/components/examples/CreateCampaign400Error' description: example + schema: + $ref: '#/components/schemas/CampaignErrorResponse' description: Bad Request summary: Update Campaign tags: - 10DLC + /accounts/{accountId}/campaignManagement/10dlc/campaigns/{campaignId}/revet: + put: + description: >- + The PUT method is used to send a request to TCR for reverification of + DCA2 declined campaign + operationId: revetCampaign + parameters: + - $ref: '#/components/parameters/AccountIdPathParam' + - $ref: '#/components/parameters/CampaignIdPathParam' + responses: + '204': + description: No Content + '403': + content: + application/xml: + examples: + example: + $ref: '#/components/examples/Campaign403Error' + description: example + schema: + $ref: '#/components/schemas/CampaignErrorResponse' + description: Forbidden + '404': + content: + application/xml: + examples: + example: + $ref: '#/components/examples/CampaignNotFound404Error' + description: example + schema: + $ref: '#/components/schemas/CampaignErrorResponse' + description: Not Found + summary: Revet Campaign + tags: + - 10DLC /accounts/{accountId}/csrs: get: description: >-