Beacon Roofing Supply User Register Services API

openapi: 3.2.0
info:
  title: Beacon Rest Services Ver 2 (OAuth) User Register Services…
  version: 24PI-4-Sprint-3
  description: 'This version uses OAuth authorization method to access API services. A bearer token is required to be authorized to access the services. [ PROD BASE URL: *https://beaconproplus.com/v2/rest/com/becn* ]


    [ UAT BASE URL: *https://beacon-uat.becn.com/v2/rest/com/becn* ]


    [ DEV BASE URL: *https://beacon-dev.becn.com/v2/rest/com/becn* ]


    ### API Site ID:


    Show... Most of the APIs supports the `apiSiteId` parameter in the following locations, the parsing priority is higher to lower. For example, if this parameter appears both in request parameter and request body, will get the one in the request parameter, any other locations will be ignored. 1. `apiSiteId` in Request Parameter/URL/Query String e.g. ```

    example.com/?apiSiteId=XYZ... example.com/?...&apiSiteId=XYZ... ```

    2. `apiSiteId` in Request Body/Payload e.g. ```

    {

    ... "apiSiteId": "XYZ",

    ... }

    ```


    Please be noted, only support when `apiSiteId` is the root element of request body. For example, the `apiSiteId` in the following request body is the second element, so this property will be ignored:

    ```

    {

    ... "foo": {

    "apiSiteId": "XYZ",

    }

    ... }

    ```

    3. `apiSiteId` related OAuth Token in Request Header e.g. ```

    Authorization Bearer atdy9au5qtg0ofkxdewwr3169... ```

    In this case, the `apiSiteId` will be parsed via the OAuth Token. For example, if one token is generated by the client id ''nigu0zjtyih7lb36l2...'', then this client related api site id(pre-defined and stored in the server database) will be the value of `apiSiteId`


    ### API Uniform Format:


    Show... ### Response:

    ```

    {

    "success":true,

    "messages":[

    {

    "key":null,

    "code":null,

    "type":"success",

    "value":""

    }

    ],

    "result":

    }

    ```

    ### Explanation:

    If the response example value of one endpoint `/foo` is:

    ```

    {

    "name":"bar",

    "age":123

    }

    ```


    Then the actual response value of this endpoint is: (replace the value of "result" element in `API Uniform Format` with example response)

    ```

    {

    "success":true,

    "messages":[

    {

    "code":null,

    "type":"success",

    "value":""

    }

    ],

    "result":{

    "name":"bar",

    "age":123

    }

    }

    ```


    ### Below V2 APIs follow original format


    Show... * `/quote`

    * `/getQuoteDetail`

    * `/getCurrentUserInfo`

    * `/getAddressBook`

    * `/createAddressBook`

    * `/updateAddressBook`

    * `/deleteAddressBook`

    * `/changePassword`

    * `/forgotPassword`

    * `/getPerfectOrderDetail`

    * `/getStatusChange`

    * `/updateStatusChange`

    * `/itemlist`

    * `/itemDetails`

    * `/addPerfectOrderToTemplate`

    * `/deleteQuote`

    * `/createQuote`

    * `/submitQuote`

    * `/getOrderShippingInfo`

    * `/addOrderShippingInfo`

    * `/suggestiveSelling`

    * `/getCurrentOrderReview`

    * `/submitCurrentOrder`

    * `/getPerfectStyleGroups`

    * `/validateOrderByLocation`

    * `/submitOrder`

    * `/submitDelegatedQuote`


    ### Explanation:

    If the response example value of one endpoint `/fooLegacy` is:

    ```

    {

    "name":"barLegacy",

    "age":456

    }

    ```


    Then the actual response value of this endpoint is: (the same as the response example)

    ```

    {

    "name":"barLegacy",

    "age":456

    }

    ```


    ### API Response Message Code


    Show... Code Group


    Code


    Comments


    1XXX:

    common request param error

    1001

    Param is required. 1002

    Repository item not found via request


    1003

    Param max length is invalid. 1004

    Param min length is invalid. 1005

    Param regular expression is invalid.'
servers:
- url: https://beaconproplus.com/v2/rest/com/becn
  description: 'Production. Added by API Evangelist; the harvested document carried no servers[]. Source: info.description of this spec: ''[ PROD BASE URL: https://beaconproplus.com/v2/rest/com/becn ]'''
tags:
- name: User Register Services
paths:
  /getUserRegisterToken:
    get:
      tags:
      - User Register Services
      summary: Get token for user register
      description: This service can return the token for user register
      responses:
        '200':
          description: 'successful operation


            refer to *API Uniform Format*

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserRegisterResponse_getUserRegisterToken'
        '405':
          description: Method not allowed, the request method is not valid for this API or this API is not available.
        '500':
          description: Internal exception
      operationId: getGetUserRegisterToken
      x-operation-id-source: derived
  /validateUserByEmail:
    post:
      tags:
      - User Register Services
      summary: Validate user by email
      description: This service can validate the user info by email
      parameters:
      - in: header
        name: X-User-Register-Token
        schema:
          type: string
        required: true
        description: The token from the response of endpoint '/getUserRegisterToken'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ValidateUserRegRequest_validateUserByEmail'
      responses:
        '200':
          description: 'successful operation


            refer to *API Uniform Format*

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserRegisterResponse_validateUserByEmail'
        '405':
          description: Method not allowed, the request method is not valid for this API or this API is not available.
        '500':
          description: Internal exception
      operationId: postValidateUserByEmail
      x-operation-id-source: derived
  /validateUserByAccount:
    post:
      tags:
      - User Register Services
      summary: Validate user by account
      description: This service can validate the user info by account
      parameters:
      - in: header
        name: X-User-Register-Token
        schema:
          type: string
        required: true
        description: The token from the response of endpoint '/getUserRegisterToken'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ValidateUserRegRequest_validateUserByAccount'
      responses:
        '200':
          description: 'successful operation


            refer to *API Uniform Format*

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserRegisterResponse_validateUserByAccount'
        '405':
          description: Method not allowed, the request method is not valid for this API or this API is not available.
        '500':
          description: Internal exception
      operationId: postValidateUserByAccount
      x-operation-id-source: derived
  /register:
    post:
      tags:
      - User Register Services
      summary: Register user
      description: This service can register user
      parameters:
      - in: header
        name: X-User-Register-Token
        schema:
          type: string
        required: true
        description: The token from the response of endpoint '/getUserRegisterToken'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserRegInfo'
      responses:
        '200':
          description: 'successful operation


            refer to *API Uniform Format*

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserRegisterResponse_register'
        '405':
          description: Method not allowed, the request method is not valid for this API or this API is not available.
        '500':
          description: Internal exception
      operationId: postRegister
      x-operation-id-source: derived
components:
  schemas:
    UserRegInfo_UserRegisterResponse_getUserRegisterToken:
      type: object
      properties:
        userRegisterToken:
          type: string
    UserRegInfo:
      type: object
      properties:
        emailAddress:
          type: string
        firstName:
          type: string
        lastName:
          type: string
        zipCode:
          type: string
        phoneNumber:
          type: string
        companyName:
          type: string
        account:
          type: string
        invoice:
          type: string
        invoiceDate:
          type: string
          format: MM-dd-yyyy
          example: 01-17-2018
        accountInfos:
          type: array
          items:
            $ref: '#/components/schemas/UserRegAccountInfo'
        internalUser:
          type: string
        token:
          type: string
        additionalEmailRecipients:
          type: array
          items:
            type: string
    UserRegisterResponseBranchSelection:
      type: object
      properties:
        accountId:
          type: string
        accountName:
          type: string
        branches:
          type: array
          items:
            $ref: '#/components/schemas/UserRegisterResponseBranchSelectionBranchInfo'
    UserRegInfo_UserRegisterResponse_validateUserByAccount:
      type: object
      properties:
        companyName:
          type: string
        account:
          type: string
        invoice:
          type: string
        invoiceDate:
          type: string
          format: MM-dd-yyyy
          example: 01-17-2018
        accountInfos:
          type: array
          items:
            $ref: '#/components/schemas/UserRegAccountInfo'
        token:
          type: string
    UserRegisterResponse_validateUserByEmail:
      type: object
      properties:
        userRegInfo:
          $ref: '#/components/schemas/UserRegInfo_UserRegisterResponse_validateUserByEmail'
        showBranchSelection:
          type: boolean
        branchSelection:
          $ref: '#/components/schemas/UserRegisterResponseBranchSelection'
        retryTimesLeft:
          type: integer
        needLogin:
          type: boolean
        needRetry:
          type: boolean
        needContactSupport:
          type: boolean
        needGetUserRegisterToken:
          type: boolean
        needInvoice:
          type: boolean
        registerSuccess:
          type: boolean
    ValidateUserRegRequest_validateUserByEmail:
      type: object
      properties:
        emailAddress:
          type: string
        firstName:
          type: string
        lastName:
          type: string
        zipCode:
          type: string
        phoneNumber:
          type: string
        g-recaptcha-response:
          type: string
          description: When recaptcha enabled on site, this token is required.Otherwise, keep it empty.
    UserRegisterResponseBranchSelectionBranchInfo:
      type: object
      properties:
        branchId:
          type: string
        branchName:
          type: string
    UserRegisterResponse_getUserRegisterToken:
      type: object
      properties:
        userRegInfo:
          $ref: '#/components/schemas/UserRegInfo_UserRegisterResponse_getUserRegisterToken'
    UserRegisterResponse_validateUserByAccount:
      type: object
      properties:
        userRegInfo:
          $ref: '#/components/schemas/UserRegInfo_UserRegisterResponse_validateUserByAccount'
        showBranchSelection:
          type: boolean
        branchSelection:
          $ref: '#/components/schemas/UserRegisterResponseBranchSelection'
        retryTimesLeft:
          type: integer
        needLogin:
          type: boolean
        needRetry:
          type: boolean
        needContactSupport:
          type: boolean
        needGetUserRegisterToken:
          type: boolean
        needInvoice:
          type: boolean
        registerSuccess:
          type: boolean
    UserRegAccountInfo:
      type: object
      properties:
        accountId:
          type: string
        accountName:
          type: string
        branchId:
          type: string
    ValidateUserRegRequest_validateUserByAccount:
      type: object
      properties:
        emailAddress:
          type: string
        companyName:
          type: string
        account:
          type: string
        invoice:
          type: string
        invoiceDate:
          type: string
          format: MM-dd-yyyy
          example: 01-17-2018
    UserRegisterResponse_register:
      type: object
      properties:
        needLogin:
          type: boolean
        needRetry:
          type: boolean
        needContactSupport:
          type: boolean
        needGetUserRegisterToken:
          type: boolean
        registerSuccess:
          type: boolean
    UserRegInfo_UserRegisterResponse_validateUserByEmail:
      type: object
      properties:
        emailAddress:
          type: string
        firstName:
          type: string
        lastName:
          type: string
        zipCode:
          type: string
        phoneNumber:
          type: string
        accountInfos:
          type: array
          items:
            $ref: '#/components/schemas/UserRegAccountInfo'
        internalUser:
          type: boolean
        beaconEmployee:
          type: boolean
        token:
          type: string
  securitySchemes:
    JSESSIONID:
      type: apiKey
      in: cookie
      name: JSESSIONID
    DYN_USER_ID:
      type: apiKey
      in: cookie
      name: DYN_USER_ID
    DYN_USER_CONFIRM:
      type: apiKey
      in: cookie
      name: DYN_USER_CONFIRM
    siteId:
      type: apiKey
      in: cookie
      name: siteId
    rememberPassword:
      type: apiKey
      in: cookie
      name: siteId