swagger: '2.0'
info:
  version: '2.0'
  title: state-codes
consumes:
  - application/json
produces:
  - application/json
paths:
  /state-codes:
    get:
      tags:
        - state-codes
      description: Get a collection of country and region codes.
      operationId: getStateCodes
      parameters:
        - name: productVendor
          in: query
          description: The third-party product or vendor that uses the state or province code that is specified as the stateAbbr value.
          required: false
          type: string
        - name: stateAbbr
          in: query
          description: The unique abbreviation for identifying the state or province.
          required: false
          type: string
        - name: stateCode
          in: query
          description: The internal state or province code. This code is assigned by the third party product or vendor.
          required: false
          type: string
        - name: offset
          in: query
          description: 'The position within the resulting dataset where the query begins returning item records. If the offset is "5", the records that returned begin with the sixth record that matches the query parameters. If the offset is "0", the records that are returned begin with the first record that matches the query parameters.'
          required: false
          type: integer
          format: int32
        - name: limit
          in: query
          description: The maximum number of records to return.
          required: false
          type: integer
          format: int32
        - name: fields
          in: query
          description: 'The comma-separated set of properties to be returned. If no properties are specified, all properties are returned.'
          required: false
          type: string
        - name: expand
          in: query
          description: 'The comma-separated set of related resources referenced in the links to be returned. If no related resources are specified, no related resources are returned.'
          required: false
          type: string
        - name: sort
          in: query
          description: 'The comma-separated set of properties which controls the order of the items being listed, prefixed by either (-) to sort by descending order, or optionally (+) to sort by ascending order. For example, sort=name,-d which means, order the items based on the name value in ascending order, then by the id value in descending order.'
          required: false
          type: string
      responses:
        '200':
          description: A collection of country and region codes.
          schema:
            $ref: '#/definitions/StateCodeCollection'
        '400':
          description: There was a client error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
        '500':
          description: There was a server error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
  '/state-codes/productVendor:{productVendor},stateAbbr:{stateAbbr}':
    get:
      tags:
        - state-codes
      description: Get a country or region code by ID.
      operationId: getStateCodeById
      parameters:
        - name: fields
          in: query
          description: 'The comma-separated set of properties to be returned. If no properties are specified, all properties are returned.'
          required: false
          type: string
        - name: expand
          in: query
          description: 'The comma-separated set of related resources referenced in the links to be returned. If no related resources are specified, no related resources are returned.'
          required: false
          type: string
        - name: sort
          in: query
          description: 'The comma-separated set of properties which controls the order of the items being listed, prefixed by either (-) to sort by descending order, or optionally (+) to sort by ascending order. For example, sort=name,-d which means, order the items based on the name value in ascending order, then by the id value in descending order.'
          required: false
          type: string
      responses:
        '200':
          description: The state or province code of a country or region.
          schema:
            $ref: '#/definitions/StateCode'
        '400':
          description: There was a client error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
        '404':
          description: The resource was not found.
        '500':
          description: There was a server error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
    parameters:
      - name: productVendor
        in: path
        description: The third-party product or vendor that uses the state or province code that is specified as the stateAbbr value.
        required: true
        type: string
      - name: stateAbbr
        in: path
        description: The unique abbreviation for identifying the state or province.
        required: true
        type: string
definitions:
  Link:
    type: object
    properties:
      href:
        type: string
        format: uri
        description: The URL of the link.
    description: Links to related resources.
  Error:
    type: object
    properties:
      code:
        type: string
        description: The error message code.
      message:
        type: string
        description: The error message.
      messageKey:
        type: string
        description: The error message key.
      messageArguments:
        type: array
        description: The arguments used to construct the error message.
        items:
          type: object
      correlationId:
        type: string
        description: The unique identifier for the request.
      locale:
        type: string
        description: The locale of the error message.
    description: The error message item model.
  ErrorResponseContainer:
    type: object
    properties:
      requestId:
        type: string
        description: The request identifier.
      errors:
        type: array
        description: The errors.
        items:
          $ref: '#/definitions/Error'
    description: The error message model.
  StateCode:
    type: object
    properties:
      productVendor:
        type: string
        description: The third-party product or vendor that uses the state or province code that is specified as the stateAbbr value.
      stateAbbr:
        type: string
        description: The unique abbreviation for identifying the state or province.
      stateCode:
        type: string
        description: The internal state or province code. This code is assigned by the third party product or vendor.
    description: The state or province code of a country or region.
  StateCodeCollection:
    type: object
    properties:
      count:
        type: integer
        format: int64
        description: The total number of items.
      items:
        type: array
        description: The items.
        items:
          $ref: '#/definitions/StateCode'
    description: A collection of country and region codes.
