Navigation :

Work Order Tags

A tag object includes custom and built-in tag information. To access tags from the Field Nation Platform, click Manage > Tags. The table below describes each parameter in the tag results and how it maps to the Field Nation app.

Tag Object

Parameter	Type	Example	Mapping/Notes
id	integer	"id":1007	Tag ID. Read-only.
label	string	"label":"Custom Tag"	Work Order Tag Management > Tag Name.
hex_color	string	"hex_color":"#F67B1E"	Work Order Tag Management > Tag Color.
valid_statuses	array	"valid_statuses":[ "created" ]	Work Order Tag Management > This tag will be used for following statuses. Not available from the Work Order Tags Response. Options “created”, “published”, “routed”, “assigned”, “workdone”, “approved”, “paid”, “canceled”
types	array	"types":[ "custom_company" ]	Tag Type. Indicates Hide From Provider or Provider Can Edit. Options “custom_company”, “for_providers_only”, “show_in_dashboard”, “provider_can_edit”, “hide_from_provider”
created	object	"created": {}	Date tag was added to Work Order. Read only. Dates and Times.

Examples

Tag Object

{
    "id": 1011,
    "label": "Tag Object",
    "hex_color": "#F67B1E",
    "valid_statuses": [
        "created",
        "published"
    ],
    "types": [
        "custom_company",
        "for_providers_only",
        "show_in_dashboard"
    ],
    "actions": [
        "edit"
    ]
}

Tags Response

The example below includes four tag objects in the tag results, each with various options and statuses.

{
   "actions":[
      "add"
   ],
   "metadata":{
      "total":4,
      "page":1,
      "pages":1,
      "per_page":5000,
      "columns":"id,label,hex_color,valid_statuses,types",
      "view":"model",
      "sort":"",
      "order":"asc"
   },
   "params":[],
   "results":[
      {
         "id":1007,
         "label":"Custom Tag",
         "hex_color":"#F67B1E",
         "valid_statuses":[
            "created",
            "published"
         ],
         "types":[
            "custom_company",
            "for_providers_only",
            "show_in_dashboard"
         ],
         "actions":[
            "edit"
         ]
      },
      {
         "id":1010,
         "label":"Custom Tag2",
         "hex_color":"#453E39",
         "valid_statuses":[
            "paid",
            "canceled"
         ],
         "types":[
            "custom_company",
            "for_providers_only",
            "show_in_dashboard"
         ],
         "actions":[
            "edit"
         ]
      },
      {
         "id":1008,
         "label":"Hidden Tag",
         "hex_color":"#1E22F6",
         "valid_statuses":[
            "routed",
            "assigned"
         ],
         "types":[
            "custom_company",
            "hide_from_provider",
            "show_in_dashboard"
         ],
         "actions":[
            "edit"
         ]
      },
      {
         "id":1009,
         "label":"Provider Edit",
         "hex_color":"#1A8018",
         "valid_statuses":[
            "workdone",
            "approved"
         ],
         "types":[
            "custom_company",
            "provider_can_edit",
            "for_providers_only",
            "show_in_dashboard"
         ],
         "actions":[
            "edit"
         ]
      }
   ]
}

Work Order Tags Response

You can locate tags in the work order > tags object. The work order tag response does not include the valid_statuses parameter. Tags may vary depending on the work order status.

"tags": { }

Work Order Tags Response

"tags":{
   "metadata":{
      "total":1,
      "per_page":1,
      "pages":1,
      "page":1
   },
   "actions":[
      "add"
   ],
   "results":[
      {
         "created":{
            "utc":"2018-12-18 15:56:35",
            "local":{
               "date":"2018-12-18",
               "time":"08:56:35"
            }
         },
         "author":{
            "id":756
         },
         "id":1007,
         "label":"Custom Tag",
         "hex_color":"#F67B1E",
         "types":[
            "custom_company",
            "show_in_dashboard",
            "for_providers_only"
         ],
         "actions":[
            "delete"
         ]
      }
   ],
   "correlation_id":"c201cd3044c4e30a5fded33a335a25c530c69a91"
}