20.03.22 Status

The statuses Object

Object PropertyRequiredObject TypeDescriptionMax Character Length
StatusYesStringStatus Name of Status50
SystemStatusTypeYesStringSystem Status Type of Status9
AccountStatusIdNoIntegerId of Status11
IsDisabledNoBooleanDisabled Status of Status1

List All statuses

Returns a list of your all statuses in your UNItekTIME account.
GET /API/statuses

Example Request

curl "https://demo.unitektime.com/api/statuses" \
      -H "APIKey: {Your API Key}" \
      -H "AuthToken: {Your Authentication Token}" \
      -H "Content-Type: application/json" \
      -H "User-Agent: MyApp (yourname@example.com)"

Example Response

[
“AccountStatusId”: 0001, “Status”: “Started”, “SystemStatusType”: “Task”, “IsDisabled”: “No” }, { “AccountStatusId”: 0002, “Status”: “OnHold”, “SystemStatusType”: “Task”, “IsDisabled”: “No” } ]

Retrieve a statuses

Retrieves the statuses with the given ID. Returns a statuses object and a 200 OK response code if a valid identifier was provided.
GET /API/statuses/{statuses_ID}

Example Request

curl "https://demo.unitektime.com/api/statuses/0002" \
      -H "APIKey: {Your API Key}" \
      -H "AuthToken: {Your Authentication Token}" \
      -H "Content-Type: application/json" \
      -H "User-Agent: MyApp (yourname@example.com)"

Example Response

[
    {
        "AccountStatusId": 0002,
        "Status": "OnHold",
        "SystemStatusType": "Task",
        "IsDisabled": "No"
    }
]

Create a statuses

Creates a statuses in your UNItekTIME account and returns the Response Message.
POST /API/statuses
Object PropertyRequiredObject TypeDescriptionMax Character Length
StatusYesStringStatus Name of Status50
SystemStatusTypeYesStringSystem Status Type of Status9

Example Request

curl "https://demo.unitektime.com/api/statuses" \
      -H "APIKey: {Your API Key}" \
      -H "AuthToken: {Your Authentication Token}" \
      -H "User-Agent: MyApp (yourname@example.com)" \
      -X POST \
      -H "Content-Type: application/json" \
      -d "{'Status': 'demo','SystemStatusType':'project'}"

Example Response

[
    {
        "id": "00001",
        "message": "status Added Successfully"
    }
]

Update a statuses

Update an statuses in your UNItekTIME account and returns the Response Message.
POST /API/statuses/{statuses_ID}

Example Request

curl "https://demo.unitektime.com/api/statuses/0001" \
      -H "APIKey: {Your API Key}" \
      -H "AuthToken: {Your Authentication Token}" \
      -H "User-Agent: MyApp (yourname@example.com)" \
      -X POST \
      -H "Content-Type: application/json" \
      -d "{'status': 'demo'}"

Example Response

[
    {
        "id": "0001",
        "message": "status Updated Successfully"
    }
]

Delete a statuses

Delete a statuses. Returns a 200 OK response code if the call succeeded.
DELETE /API/statuses/{statuses_ID}

Example Request

curl "https://demo.unitektime.com/api/statuses/0001" \
      -H "APIKey: {Your API Key}" \
      -H "AuthToken: {Your Authentication Token}" \
      -H "User-Agent: MyApp (yourname@example.com)" \
      -X DELETE \
      -H "Content-Type: application/json"

Example Response

[
    {
        "id": "0001",
        "message": "status Delete Successfully"
    }
]