GET api/backoffice/v{version}/statuses

Request Information

URI Parameters

Name	Description	Type	Additional information
version		string	None.

Body Parameters

None.

Response Information

Resource Description

StatusList

Name	Description	Type	Additional information
statuses		Collection of Status	None.

Response Formats

application/json, text/json

Sample:

{
  "statuses": [
    {
      "id": 1,
      "code": "sample string 2",
      "colour": "sample string 3",
      "complete": 4,
      "cancelled": 5,
      "company_id": 6,
      "primary_eventtype_id": 7,
      "updated_at": "sample string 8",
      "created_at": "sample string 9",
      "deleted_at": "sample string 10",
      "status_eventtype_ids": [
        1,
        2
      ]
    },
    {
      "id": 1,
      "code": "sample string 2",
      "colour": "sample string 3",
      "complete": 4,
      "cancelled": 5,
      "company_id": 6,
      "primary_eventtype_id": 7,
      "updated_at": "sample string 8",
      "created_at": "sample string 9",
      "deleted_at": "sample string 10",
      "status_eventtype_ids": [
        1,
        2
      ]
    }
  ]
}

text/html

Sample:

{"statuses":[{"id":1,"code":"sample string 2","colour":"sample string 3","complete":4,"cancelled":5,"company_id":6,"primary_eventtype_id":7,"updated_at":"sample string 8","created_at":"sample string 9","deleted_at":"sample string 10","status_eventtype_ids":[1,2]},{"id":1,"code":"sample string 2","colour":"sample string 3","complete":4,"cancelled":5,"company_id":6,"primary_eventtype_id":7,"updated_at":"sample string 8","created_at":"sample string 9","deleted_at":"sample string 10","status_eventtype_ids":[1,2]}]}

application/xml, text/xml

Sample:

<StatusList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DispatchITV2.Models.Data">
  <statuses>
    <Status>
      <cancelled>5</cancelled>
      <code>sample string 2</code>
      <colour>sample string 3</colour>
      <company_id>6</company_id>
      <complete>4</complete>
      <created_at>sample string 9</created_at>
      <deleted_at>sample string 10</deleted_at>
      <id>1</id>
      <primary_eventtype_id>7</primary_eventtype_id>
      <status_eventtype_ids xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </status_eventtype_ids>
      <updated_at>sample string 8</updated_at>
    </Status>
    <Status>
      <cancelled>5</cancelled>
      <code>sample string 2</code>
      <colour>sample string 3</colour>
      <company_id>6</company_id>
      <complete>4</complete>
      <created_at>sample string 9</created_at>
      <deleted_at>sample string 10</deleted_at>
      <id>1</id>
      <primary_eventtype_id>7</primary_eventtype_id>
      <status_eventtype_ids xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </status_eventtype_ids>
      <updated_at>sample string 8</updated_at>
    </Status>
  </statuses>
</StatusList>