PUT api/backoffice/v{version}/statuses/{id}

Request Information

URI Parameters

Name	Description	Type	Additional information
id		integer	Required
version		string	None.

Body Parameters

Status

Name	Type	Additional information
id	integer	None.
code	string	None.
colour	string	None.
complete	integer	None.
cancelled	integer	None.
company_id	integer	None.
primary_eventtype_id	integer	None.
updated_at	string	None.
created_at	string	None.
deleted_at	string	None.
status_eventtype_ids	Collection of integer	None.

Request Formats

application/json, text/json

Sample:

{
  "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:

{"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:

<Status xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DispatchITV2.Models.Data">
  <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:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </status_eventtype_ids>
  <updated_at>sample string 8</updated_at>
</Status>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'Status'.

Response Information

Resource Description

Object

None.

Response Formats

application/json, text/json, text/html

Sample:

{}

application/xml, text/xml

Sample:

<z:anyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" />