diff --git a/certified-connectors/FieldEquip/apiDefinition.swagger.json b/certified-connectors/FieldEquip/apiDefinition.swagger.json index 4775abe251..cbe6b8a27f 100644 --- a/certified-connectors/FieldEquip/apiDefinition.swagger.json +++ b/certified-connectors/FieldEquip/apiDefinition.swagger.json @@ -18,7 +18,8 @@ "consumes": [], "produces": [], "paths": { - "/customerExt": { + "/customerExt": {}, + "/customer": { "get": { "responses": { "default": { @@ -36,31 +37,32 @@ "in": "query", "required": true, "type": "string", - "x-ms-summary": "Company ID", - "description": "Enter Company ID" + "x-ms-visibility": "advanced", + "description": "Company ID", + "x-ms-summary": "Identification parameter for the company information passed" }, { "name": "x-api-key", "in": "header", "required": true, "type": "string", - "x-ms-summary": "API Key", - "x-ms-visibility": "important", - "description": "Enter API key", - "default": "" + "description": "API Key", + "x-ms-visibility": "advanced", + "x-ms-summary": "API Key for Authorization" }, { "name": "x-origin", "in": "header", "required": true, "type": "string", - "x-ms-visibility": "important", - "x-ms-summary": "Origin", - "description": "Enter the base URL to make a request", - "default": "https://qa.fieldequip.com" + "description": "Origin", + "x-ms-summary": "Origin URL", + "x-ms-visibility": "advanced" } ] - }, + } + }, + "/customer/create": { "post": { "responses": { "default": { @@ -69,137 +71,141 @@ } }, "summary": "Create Records", - "description": "Action to perform update, and insertion of records", + "description": "Create Customer Records", "operationId": "CreateRecords", "x-ms-visibility": "important", "parameters": [ { "name": "companyId", "in": "query", - "required": true, - "x-ms-summary": "Company ID", - "description": "Enter Company ID", - "type": "string" + "required": false, + "type": "string", + "x-ms-summary": "Identification parameter for the company information passed", + "description": "Company ID" }, { "name": "x-api-key", "in": "header", "required": true, "type": "string", - "x-ms-summary": "API Key", + "description": "API Key", "x-ms-visibility": "important", - "description": "Enter API Key", - "default": "" + "x-ms-summary": "API Key for Authorization" }, { "name": "x-origin", "in": "header", "required": true, "type": "string", + "description": "Origin", "x-ms-visibility": "important", - "x-ms-summary": "Origin", - "description": "Enter the base URL to make a request", - "default": "https://qa.fieldequip.com" + "x-ms-summary": "Origin for the URL" }, { "name": "body", "in": "body", "required": false, "schema": { - "type": "object", - "properties": { - "companyId": { - "type": "string", - "description": "companyId" - }, - "customerId": { - "type": "string", - "description": "customerId" - }, - "customerName": { - "type": "string", - "description": "customerName" - }, - "billingAddress1": { - "type": "string", - "description": "billingAddress1", - "title": "" - }, - "billingAddress2": { - "type": "string", - "description": "billingAddress2" - }, - "billingCity": { - "type": "string", - "description": "billingCity" - }, - "billingState": { - "type": "string", - "description": "billingState" - }, - "billingZipCode": { - "type": "string", - "description": "billingZipCode" - }, - "billingCountryCode": { - "type": "string", - "description": "billingCountryCode" - }, - "customerPhone": { - "type": "string", - "description": "customerPhone" - }, - "customerStatus": { - "type": "string", - "description": "customerStatus" - }, - "contactId": { - "type": "string", - "description": "contactId" - }, - "contactName": { - "type": "string", - "description": "contactName" - }, - "contactEmail": { - "type": "string", - "description": "contactEmail" - }, - "contactPhone": { - "type": "string", - "description": "contactPhone" - }, - "contactMobile": { - "type": "string", - "description": "contactMobile" - }, - "shipToName": { - "type": "string", - "description": "shipToName" - }, - "shipToAddress1": { - "type": "string", - "description": "shipToAddress1" - }, - "shipToAddress2": { - "type": "string", - "description": "shipToAddress2" - }, - "shipToCity": { - "type": "string", - "description": "shipToCity" - }, - "shipToState": { - "type": "string", - "description": "shipToState" - }, - "shipToZipCode": { - "type": "string", - "description": "shipToZipCode" - }, - "shipToCountryCode": { - "type": "string", - "description": "shipToCountryCode" + "type": "array", + "items": { + "type": "object", + "properties": { + "companyId": { + "type": "string", + "description": "companyId" + }, + "customerId": { + "type": "string", + "description": "customerId" + }, + "customerName": { + "type": "string", + "description": "customerName" + }, + "businessUnitCode": { + "type": "string", + "description": "businessUnitCode" + }, + "billingAddress1": { + "type": "string", + "description": "billingAddress1" + }, + "billingAddress2": { + "type": "string", + "description": "billingAddress2" + }, + "billingCity": { + "type": "string", + "description": "billingCity" + }, + "billingState": { + "type": "string", + "description": "billingState" + }, + "billingZipCode": { + "type": "string", + "description": "billingZipCode" + }, + "billingCountryCode": { + "type": "string", + "description": "billingCountryCode" + }, + "customerPhone": { + "type": "string", + "description": "customerPhone" + }, + "customerStatus": { + "type": "string", + "description": "customerStatus" + }, + "contactId": { + "type": "string", + "description": "contactId" + }, + "contactName": { + "type": "string", + "description": "contactName" + }, + "contactEmail": { + "type": "string", + "description": "contactEmail" + }, + "contactPhone": { + "type": "string", + "description": "contactPhone" + }, + "contactMobile": { + "type": "string", + "description": "contactMobile" + }, + "shipToName": { + "type": "string", + "description": "shipToName" + }, + "shipToAddress1": { + "type": "string", + "description": "shipToAddress1" + }, + "shipToAddress2": { + "type": "string", + "description": "shipToAddress2" + }, + "shipToCity": { + "type": "string", + "description": "shipToCity" + }, + "shipToState": { + "type": "string", + "description": "shipToState" + }, + "shipToZipCode": { + "type": "string", + "description": "shipToZipCode" + }, + "shipToCountryCode": { + "type": "string", + "description": "shipToCountryCode" + } } } }