JobType and Skill
-----------------

This API allows listing, retrieving, creating, updating,
and deleting jobtype and skills as well as associate skills to jobtype.


List JobType
............

.. http:get:: /jobtype/

   List all jobtypes.

   **Sample request**:

   .. sourcecode:: http

      GET /jobtype/ HTTP/1.1
      Host: api.fieldaware.net
      Authorization: Token 9dcae3660ec84eac94bb506e09a9af40
      Accept: application/json

   **Sample response**:

   .. sourcecode:: http

      HTTP/1.1 200 OK
      Content-Type: application/json

      {
        "count": 100,
        "items": [
          {
            "name": "Standard Service",
            "uuid": "d6d22438096503fe72a7c161201c9373"
          },
          {
            "name": "Installation",
            "uuid": "28a01f359aabafb4ff28347bddd9a24f"
          },
          {
            "name": "Special Installation",
            "uuid": "6a360274f3fa2e224e17ba9ece3f4b0a"
          }
        ],
        "page": 0,
        "pageSize": 3,
        "sortedBy": []
      }

   :query sortedBy: Available sorting criteria: ``name``
   :query name: A filtering value for jobtype name


Get JobType
...........

.. http:get:: /jobtype/(jobtype_ref)

   Retrieve a given jobtype.

   **Sample request**:

   .. sourcecode:: http

      GET /jobtype/d6d22438096503fe72a7c161201c9373 HTTP/1.1
      Host: api.fieldaware.net
      Authorization: Token 9dcae3660ec84eac94bb506e09a9af40
      Accept: application/json

   **Sample response**:

   .. sourcecode:: http

      HTTP/1.1 200 OK
      Content-Type: application/json

      {
        "name": "Standard Service Heat Cable",
        "uuid": "d6d22438096503fe72a7c161201c9373",
        "archived": false
      }


Create JobType
..............

.. http:post:: /jobtype/

   Create a new jobtype.

   **Sample request**:

   .. sourcecode:: http

      POST /jobtype/ HTTP/1.1
      Host: api.fieldaware.net
      Authorization: Token 9dcae3660ec84eac94bb506e09a9af40
      Accept: application/json

      {
        "name": "A new Service"
      }

   :<json string name: Name of the jobtype (required)

   **Sample response**:

   .. sourcecode:: http

      HTTP/1.1 201 Created
      Content-Type: application/json

      {
        "name": "A new Service",
        "uuid": "00bd62a92a004faea233951510167cad"
      }



Update JobType
..............

.. http:put:: /jobtype/(jobtype_ref)

   Update a given skill.

   **Sample request**:

   .. sourcecode:: http

     PUT /jobtype/d6d22438096503fe72a7c161201c9373 HTTP/1.1
     Host: api.fieldaware.net
     Authorization: Token 687fe20baeef448bb30db579139dad33
     Accept: application/json

     {
       "name": "Updated Service"
     }

   **Sample response**:

   .. sourcecode:: http

      HTTP/1.1 204 NO CONTENT


Archive JobType
.......................

.. http:put:: /jobtype/(jobtype_ref)/archive

   Archives a given JobType. By archiving a JobType it will be
   removed from any customers using it.

   **Sample request**:

   .. sourcecode:: http

     PUT /jobtype/d6d22438096503fe72a7c161201c9373/archive HTTP/1.1
     Host: api.fieldaware.net
     Authorization: Token 687fe20baeef448bb30db579139dad33
     Accept: application/json

   **Sample response**:

   .. sourcecode:: http

      HTTP/1.1 204 NO CONTENT

  :statuscode 204: if the job type is successfully archived
  :statuscode 409: if the job type is already archived


Unarchive JobType
.........................

.. http:put:: /jobtype/(jobtype_ref)/unarchive

   Unarchives a previously archived JobType.

   **Sample request**:

   .. sourcecode:: http

     PUT /jobtype/d6d22438096503fe72a7c161201c9373/unarchive HTTP/1.1
     Host: api.fieldaware.net
     Authorization: Token 687fe20baeef448bb30db579139dad33
     Accept: application/json

   **Sample response**:

   .. sourcecode:: http

      HTTP/1.1 204 NO CONTENT

  :statuscode 204: if the job type is successfully unarchived
  :statuscode 409: if the job type is not archived


Delete JobType
..............

.. http:delete:: /jobtype/(jobtype_ref)

   Delete a given jobtype.

   **Sample request**:

   .. sourcecode:: http

      DELETE /jobtype/00bd62a92a004faea233951510167cad HTTP/1.1
      Host: api.fieldaware.net
      Authorization: Token 687fe20baeef448bb30db579139dad33
      Accept: application/json

   **Sample response**:

   .. sourcecode:: http

    HTTP/1.1 204 No Content



List Skill
..........

.. http:get:: /skill/

   List all skills.

   **Sample request**:

   .. sourcecode:: http

      GET /skill/ HTTP/1.1
      Host: api.fieldaware.net
      Authorization: Token 9dcae3660ec84eac94bb506e09a9af40
      Accept: application/json

   **Sample response**:

   .. sourcecode:: http

      HTTP/1.1 200 OK
      Content-Type: application/json

      {
        "count": 100,
        "items": [
          {
            "name": "Standard Skill",
            "uuid": "d6d22438096503fe72a7c161201c9373"
          },
          {
            "name": "Installation Skill",
            "uuid": "28a01f359aabafb4ff28347bddd9a24f"
          },
          {
            "name": "Special Installation Skill",
            "uuid": "6a360274f3fa2e224e17ba9ece3f4b0a"
          }
        ],
        "page": 0,
        "pageSize": 3,
        "sortedBy": []
      }

   :query sortedBy: Available sorting criteria: ``name``
   :query name: A filtering value for skill name


Get Skill
.........

.. http:get:: /skill/(skill_ref)

   Retrieve a given skill.

   **Sample request**:

   .. sourcecode:: http

      GET /skill/d6d22438096503fe72a7c161201c9373 HTTP/1.1
      Host: api.fieldaware.net
      Authorization: Token 9dcae3660ec84eac94bb506e09a9af40
      Accept: application/json

   **Sample response**:

   .. sourcecode:: http

      HTTP/1.1 200 OK
      Content-Type: application/json

      {
        "name": "Standard Skill",
        "uuid": "d6d22438096503fe72a7c161201c9373"
      }


Create Skill
............

.. http:post:: /skill/

   Create a new skill.

   **Sample request**:

   .. sourcecode:: http

      POST /skill/ HTTP/1.1
      Host: api.fieldaware.net
      Authorization: Token 9dcae3660ec84eac94bb506e09a9af40
      Accept: application/json

      {
        "name": "A new Skill"
      }

   :<json string name: Name of the skill (required)

   **Sample response**:

   .. sourcecode:: http

      HTTP/1.1 201 Created
      Content-Type: application/json

      {
        "name": "A new Skill",
        "uuid": "00bd62a92a004faea233951510167cad"
      }


Update Skill
............

.. http:put:: /skill/(skill_ref)

   Update a given skill.

   **Sample request**:

   .. sourcecode:: http

     PUT /skill/d6d22438096503fe72a7c161201c9373 HTTP/1.1
     Host: api.fieldaware.net
     Authorization: Token 687fe20baeef448bb30db579139dad33
     Accept: application/json

     {
       "name": "Updated Skill"
     }

   **Sample response**:

   .. sourcecode:: http

      HTTP/1.1 204 NO CONTENT


Delete Skill
............

.. http:delete:: /skill/(skill_ref)

   Delete a given skill.

   **Sample request**:

   .. sourcecode:: http

      DELETE /skill/00bd62a92a004faea233951510167cad HTTP/1.1
      Host: api.fieldaware.net
      Authorization: Token 687fe20baeef448bb30db579139dad33
      Accept: application/json

   **Sample response**:

   .. sourcecode:: http

    HTTP/1.1 204 No Content



Associate Skills to a JobType
.............................


.. http:post:: /jobtype/(jobtype_ref)/skill/

   Create or update JobType-Skill association.

   **Sample request**:

   .. sourcecode:: http

      POST /jobtype/d6d22438096503fe72a7c161201c9373/skill/ HTTP/1.1
      Host: api.fieldaware.net
      Authorization: Token 9dcae3660ec84eac94bb506e09a9af40
      Accept: application/json

      {
        "skills": [
          {
            "skill": {"uuid": "00bd62a92a004faea233951510167cad"},
            "required": true
          },
          {
            "skill": {"uuid": "bd62a0092a0041510167cadfaea23395"},
            "required": false
          }
        ]
      }

   :<json string required: Whether the skill is mandatory for the JobType

   **Sample response**:

   .. sourcecode:: http

      HTTP/1.1 204 No Content
      Content-Type: application/json


List Skills associated to a JobType
...................................


.. http:get:: /jobtype/(jobtype_ref)/skill/

   List al JobType-Skill associations.

   **Sample request**:

   .. sourcecode:: http

      GET /jobtype/d6d22438096503fe72a7c161201c9373/skill/ HTTP/1.1
      Host: api.fieldaware.net
      Authorization: Token 9dcae3660ec84eac94bb506e09a9af40
      Accept: application/json

   **Sample response**:

   .. sourcecode:: http

      HTTP/1.1 200 OK
      Content-Type: application/json

      {"skills": [
          {
            {"skill": {"uuid": "00bd62a92a004faea233951510167cad"},
            "required": true,
            "name": "update skill"
          },
          {
            {"skill": {"uuid": "aea233951510167cad00bd62a92a004f"},
            "required": false,
            "name": "new skill"
          }
        ]
      }