Skip to content

Commit

Permalink
incorporation application changes for api spec (#2871)
Browse files Browse the repository at this point in the history
* incorporation application changes for api spec

* removed id from request body

* replaced date and nrnum

* replaced account id with mock val

* fixed indent

* added 401 unauthorized response

* changed date string types and values
  • Loading branch information
PaulGarewal authored Jul 31, 2024
1 parent 1e0ccc2 commit 5f8cbf2
Showing 1 changed file with 193 additions and 0 deletions.
193 changes: 193 additions & 0 deletions docs/oas/business.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2439,6 +2439,109 @@ paths:
type: object
properties: {}
examples:
incorporation-application-success-response:
summary: Incorporation Application Response
value:
errors:
- null
filing:
business:
identifier: Tqcbbbc157
header:
accountId: 6164
affectedFilings: []
availableOnPaperOnly: false
certifiedBy: API Specs
colinIds: []
comments: []
date: '2024-07-25'
deletionLocked: false
effectiveDate: '2024-07-25T16:17:57.191129+00:00'
email: [email protected]
filingId: 150333
inColinOnly: false
isCorrected: false
isCorrectionPending: false
name: incorporationApplication
status: DRAFT
submitter: mocked submitter
incorporationApplication:
contactPoint:
email: [email protected]
phone: 123-456-7890
nameRequest:
legalType: BEN
nrNumber: 'NR 1345876'
offices:
recordsOffice:
deliveryAddress:
addressCity: delivery_address city
addressCountry: CA
addressRegion: BC
postalCode: H0H0H0
streetAddress: delivery_address - address line one
mailingAddress:
addressCity: mailing_address city
addressCountry: CA
addressRegion: BC
postalCode: H0H0H0
streetAddress: mailing_address - address line one
registeredOffice:
deliveryAddress:
addressCity: delivery_address city
addressCountry: CA
addressRegion: BC
postalCode: H0H0H0
streetAddress: delivery_address - address line one
mailingAddress:
addressCity: mailing_address city
addressCountry: CA
addressRegion: BC
postalCode: H0H0H0
streetAddress: mailing_address - address line one
parties:
- mailingAddress:
addressCity: Victoria
addressCountry: CA
addressRegion: BC
postalCode: V8W 3E6
streetAddress: 200-940 Blanshard St
streetAddressAdditional: ''
officer:
email: [email protected]
firstName: BCREGTEST Lucille
id: 'p90x2145'
lastName: TWENTY
middleName: ''
organizationName: ''
partyType: person
roles:
- appointmentDate: '2024-07-24'
roleType: Completing Party
- deliveryAddress:
addressCity: Burnaby
addressCountry: CA
addressRegion: BC
postalCode: V5E 1R9
streetAddress: 6767 Burford St
streetAddressAdditional: ''
mailingAddress:
addressCity: Burnaby
addressCountry: CA
addressRegion: BC
postalCode: V5E 1R9
streetAddress: 6767 Burford St
streetAddressAdditional: ''
officer:
firstName: Director
id: 'p90x2145'
lastName: Test
middleName: ''
organizationName: ''
partyType: person
roles:
- appointmentDate: '2024-07-24'
roleType: Director
amalgamation-regular-success-response:
summary: Amalgamation Regular Response
value:
Expand Down Expand Up @@ -2773,13 +2876,103 @@ paths:
value:
errorMessage: API backend third party service error.
rootCause: message:You are not authorized to submit a filing for TgtPxoS4FF.
incorporation-unauthorized-response:
summary: Incorporation - Not Authorized To Submit Response
value:
errorMessage: API backend third party service error.
rootCause: message:You are not authorized to submit a filing for TgtPxoS4FF.
description: Submitting a creation filing for a business will create that type of business if it is a fully valid filing and payment has been completed.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Filing'
examples:
incorporation-application-request:
summary: Incorporation Application Request
value:
filing:
header:
certifiedBy: API Specs
email: [email protected]
name: incorporationApplication
date: '2024-07-25'
accountId: 6164
incorporationApplication:
nameRequest:
legalType: BEN
nrNumber: NR 1234567
offices:
registeredOffice:
deliveryAddress:
streetAddress: delivery_address - address line one
addressCity: delivery_address city
addressCountry: CA
postalCode: H0H0H0
addressRegion: BC
mailingAddress:
streetAddress: mailing_address - address line one
addressCity: mailing_address city
addressCountry: CA
postalCode: H0H0H0
addressRegion: BC
recordsOffice:
deliveryAddress:
streetAddress: delivery_address - address line one
addressCity: delivery_address city
addressCountry: CA
postalCode: H0H0H0
addressRegion: BC
mailingAddress:
streetAddress: mailing_address - address line one
addressCity: mailing_address city
addressCountry: CA
postalCode: H0H0H0
addressRegion: BC
contactPoint:
email: [email protected]
phone: 123-456-7890
parties:
- mailingAddress:
addressCity: Victoria
addressCountry: CA
addressRegion: BC
postalCode: V8W 3E6
streetAddress: 200-940 Blanshard St
streetAddressAdditional: ''
officer:
email: [email protected]
firstName: BCREGTEST Lucille
lastName: TWENTY
middleName: ''
organizationName: ''
partyType: person
roles:
- appointmentDate: '2024-07-24'
roleType: Completing Party
- deliveryAddress:
addressCity: Burnaby
addressCountry: CA
addressRegion: BC
postalCode: V5E 1R9
streetAddress: 6767 Burford St
streetAddressAdditional: ''
mailingAddress:
addressCity: Burnaby
addressCountry: CA
addressRegion: BC
postalCode: V5E 1R9
streetAddress: 6767 Burford St
streetAddressAdditional: ''
officer:
firstName: Director
lastName: Test
middleName: ''
organizationName: ''
partyType: person
roles:
- appointmentDate: '2024-07-24'
roleType: Director
amalgamation-regular-request:
summary: Amalgamation Regular Request
value:
Expand Down

0 comments on commit 5f8cbf2

Please sign in to comment.