Skip to content

Commit cdba372

Browse files
dj1998-sysdj1998-sys
authored
updated swagger file (#4040)
1 parent 8e2d5f4 commit cdba372

File tree

1 file changed

+123
-117
lines changed

1 file changed

+123
-117
lines changed

‎certified-connectors/FieldEquip/apiDefinition.swagger.json‎

Lines changed: 123 additions & 117 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@
1818
"consumes": [],
1919
"produces": [],
2020
"paths": {
21-
"/customerExt": {
21+
"/customerExt": {},
22+
"/customer": {
2223
"get": {
2324
"responses": {
2425
"default": {
@@ -36,31 +37,32 @@
3637
"in": "query",
3738
"required": true,
3839
"type": "string",
39-
"x-ms-summary": "Company ID",
40-
"description": "Enter Company ID"
40+
"x-ms-visibility": "advanced",
41+
"description": "Company ID",
42+
"x-ms-summary": "Identification parameter for the company information passed"
4143
},
4244
{
4345
"name": "x-api-key",
4446
"in": "header",
4547
"required": true,
4648
"type": "string",
47-
"x-ms-summary": "API Key",
48-
"x-ms-visibility": "important",
49-
"description": "Enter API key",
50-
"default": ""
49+
"description": "API Key",
50+
"x-ms-visibility": "advanced",
51+
"x-ms-summary": "API Key for Authorization"
5152
},
5253
{
5354
"name": "x-origin",
5455
"in": "header",
5556
"required": true,
5657
"type": "string",
57-
"x-ms-visibility": "important",
58-
"x-ms-summary": "Origin",
59-
"description": "Enter the base URL to make a request",
60-
"default": "https://qa.fieldequip.com"
58+
"description": "Origin",
59+
"x-ms-summary": "Origin URL",
60+
"x-ms-visibility": "advanced"
6161
}
6262
]
63-
},
63+
}
64+
},
65+
"/customer/create": {
6466
"post": {
6567
"responses": {
6668
"default": {
@@ -69,137 +71,141 @@
6971
}
7072
},
7173
"summary": "Create Records",
72-
"description": "Action to perform update, and insertion of records",
74+
"description": "Create Customer Records",
7375
"operationId": "CreateRecords",
7476
"x-ms-visibility": "important",
7577
"parameters": [
7678
{
7779
"name": "companyId",
7880
"in": "query",
79-
"required": true,
80-
"x-ms-summary": "Company ID",
81-
"description": "Enter Company ID",
82-
"type": "string"
81+
"required": false,
82+
"type": "string",
83+
"x-ms-summary": "Identification parameter for the company information passed",
84+
"description": "Company ID"
8385
},
8486
{
8587
"name": "x-api-key",
8688
"in": "header",
8789
"required": true,
8890
"type": "string",
89-
"x-ms-summary": "API Key",
91+
"description": "API Key",
9092
"x-ms-visibility": "important",
91-
"description": "Enter API Key",
92-
"default": ""
93+
"x-ms-summary": "API Key for Authorization"
9394
},
9495
{
9596
"name": "x-origin",
9697
"in": "header",
9798
"required": true,
9899
"type": "string",
100+
"description": "Origin",
99101
"x-ms-visibility": "important",
100-
"x-ms-summary": "Origin",
101-
"description": "Enter the base URL to make a request",
102-
"default": "https://qa.fieldequip.com"
102+
"x-ms-summary": "Origin for the URL"
103103
},
104104
{
105105
"name": "body",
106106
"in": "body",
107107
"required": false,
108108
"schema": {
109-
"type": "object",
110-
"properties": {
111-
"companyId": {
112-
"type": "string",
113-
"description": "companyId"
114-
},
115-
"customerId": {
116-
"type": "string",
117-
"description": "customerId"
118-
},
119-
"customerName": {
120-
"type": "string",
121-
"description": "customerName"
122-
},
123-
"billingAddress1": {
124-
"type": "string",
125-
"description": "billingAddress1",
126-
"title": ""
127-
},
128-
"billingAddress2": {
129-
"type": "string",
130-
"description": "billingAddress2"
131-
},
132-
"billingCity": {
133-
"type": "string",
134-
"description": "billingCity"
135-
},
136-
"billingState": {
137-
"type": "string",
138-
"description": "billingState"
139-
},
140-
"billingZipCode": {
141-
"type": "string",
142-
"description": "billingZipCode"
143-
},
144-
"billingCountryCode": {
145-
"type": "string",
146-
"description": "billingCountryCode"
147-
},
148-
"customerPhone": {
149-
"type": "string",
150-
"description": "customerPhone"
151-
},
152-
"customerStatus": {
153-
"type": "string",
154-
"description": "customerStatus"
155-
},
156-
"contactId": {
157-
"type": "string",
158-
"description": "contactId"
159-
},
160-
"contactName": {
161-
"type": "string",
162-
"description": "contactName"
163-
},
164-
"contactEmail": {
165-
"type": "string",
166-
"description": "contactEmail"
167-
},
168-
"contactPhone": {
169-
"type": "string",
170-
"description": "contactPhone"
171-
},
172-
"contactMobile": {
173-
"type": "string",
174-
"description": "contactMobile"
175-
},
176-
"shipToName": {
177-
"type": "string",
178-
"description": "shipToName"
179-
},
180-
"shipToAddress1": {
181-
"type": "string",
182-
"description": "shipToAddress1"
183-
},
184-
"shipToAddress2": {
185-
"type": "string",
186-
"description": "shipToAddress2"
187-
},
188-
"shipToCity": {
189-
"type": "string",
190-
"description": "shipToCity"
191-
},
192-
"shipToState": {
193-
"type": "string",
194-
"description": "shipToState"
195-
},
196-
"shipToZipCode": {
197-
"type": "string",
198-
"description": "shipToZipCode"
199-
},
200-
"shipToCountryCode": {
201-
"type": "string",
202-
"description": "shipToCountryCode"
109+
"type": "array",
110+
"items": {
111+
"type": "object",
112+
"properties": {
113+
"companyId": {
114+
"type": "string",
115+
"description": "companyId"
116+
},
117+
"customerId": {
118+
"type": "string",
119+
"description": "customerId"
120+
},
121+
"customerName": {
122+
"type": "string",
123+
"description": "customerName"
124+
},
125+
"businessUnitCode": {
126+
"type": "string",
127+
"description": "businessUnitCode"
128+
},
129+
"billingAddress1": {
130+
"type": "string",
131+
"description": "billingAddress1"
132+
},
133+
"billingAddress2": {
134+
"type": "string",
135+
"description": "billingAddress2"
136+
},
137+
"billingCity": {
138+
"type": "string",
139+
"description": "billingCity"
140+
},
141+
"billingState": {
142+
"type": "string",
143+
"description": "billingState"
144+
},
145+
"billingZipCode": {
146+
"type": "string",
147+
"description": "billingZipCode"
148+
},
149+
"billingCountryCode": {
150+
"type": "string",
151+
"description": "billingCountryCode"
152+
},
153+
"customerPhone": {
154+
"type": "string",
155+
"description": "customerPhone"
156+
},
157+
"customerStatus": {
158+
"type": "string",
159+
"description": "customerStatus"
160+
},
161+
"contactId": {
162+
"type": "string",
163+
"description": "contactId"
164+
},
165+
"contactName": {
166+
"type": "string",
167+
"description": "contactName"
168+
},
169+
"contactEmail": {
170+
"type": "string",
171+
"description": "contactEmail"
172+
},
173+
"contactPhone": {
174+
"type": "string",
175+
"description": "contactPhone"
176+
},
177+
"contactMobile": {
178+
"type": "string",
179+
"description": "contactMobile"
180+
},
181+
"shipToName": {
182+
"type": "string",
183+
"description": "shipToName"
184+
},
185+
"shipToAddress1": {
186+
"type": "string",
187+
"description": "shipToAddress1"
188+
},
189+
"shipToAddress2": {
190+
"type": "string",
191+
"description": "shipToAddress2"
192+
},
193+
"shipToCity": {
194+
"type": "string",
195+
"description": "shipToCity"
196+
},
197+
"shipToState": {
198+
"type": "string",
199+
"description": "shipToState"
200+
},
201+
"shipToZipCode": {
202+
"type": "string",
203+
"description": "shipToZipCode"
204+
},
205+
"shipToCountryCode": {
206+
"type": "string",
207+
"description": "shipToCountryCode"
208+
}
203209
}
204210
}
205211
}

0 commit comments

Comments
 (0)