ServiceNotes
Provides access to service notes.
GET /its/service-notes
Returns a set of service notes. There are five parameters that can be passed to the collection query: degraded: [yes|no] scheduled: [yes|no] sort-by: {field-name} date: [date] (as m/d/Y) current: [yes|no] (no is provided by default)
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| AutoID | NO | ||
| ShortDesc | Short service note description | YES | |
| LongDesc | Long service note description | YES | |
| EndDate | Date service note will display through | YES | |
| timedown | Date and time the service went down or is going down | NO | |
| timeup | Date and time the service came back up or will be coming back up | NO | |
| scheduled | Flag whether the outage was scheduled or not | NO | |
| degraded | Flag whether the outage was degraded or not | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.its.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.its.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/its/service-notes"
},
"first": {
"href": "/its/service-notes?page={page}"
},
"prev": {
"href": "/its/service-notes?page={page}"
},
"next": {
"href": "/its/service-notes?page={page}"
},
"last": {
"href": "/its/service-notes?page={page}"
}
}
"_embedded": {
"service_notes": [
{
"_links": {
"self": {
"href": "/its/service-notes[/:service_notes_id]"
}
}
"AutoID": "",
"ShortDesc": "Short service note description",
"LongDesc": "Long service note description",
"EndDate": "Date service note will display through",
"timedown": "Date and time the service went down or is going down",
"timeup": "Date and time the service came back up or will be coming back up",
"scheduled": "Flag whether the outage was scheduled or not",
"degraded": "Flag whether the outage was degraded or not"
}
]
}
}
POST /its/service-notes
Creates a new service note.
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| AutoID | NO | ||
| ShortDesc | Short service note description | YES | |
| LongDesc | Long service note description | YES | |
| EndDate | Date service note will display through | YES | |
| timedown | Date and time the service went down or is going down | NO | |
| timeup | Date and time the service came back up or will be coming back up | NO | |
| scheduled | Flag whether the outage was scheduled or not | NO | |
| degraded | Flag whether the outage was degraded or not | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.its.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.its.v1+json
application/json |
Body
{
"ShortDesc": "Short service note description",
"LongDesc": "Long service note description",
"EndDate": "Date service note will display through",
"timedown": "Date and time the service went down or is going down",
"timeup": "Date and time the service came back up or will be coming back up",
"scheduled": "Flag whether the outage was scheduled or not",
"degraded": "Flag whether the outage was degraded or not"
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.its.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/its/service-notes[/:service_notes_id]"
}
}
"AutoID": "",
"ShortDesc": "Short service note description",
"LongDesc": "Long service note description",
"EndDate": "Date service note will display through",
"timedown": "Date and time the service went down or is going down",
"timeup": "Date and time the service came back up or will be coming back up",
"scheduled": "Flag whether the outage was scheduled or not",
"degraded": "Flag whether the outage was degraded or not"
}
GET /its/service-notes[/:service_notes_id]
Returns a single service note.
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| AutoID | NO | ||
| ShortDesc | Short service note description | YES | |
| LongDesc | Long service note description | YES | |
| EndDate | Date service note will display through | YES | |
| timedown | Date and time the service went down or is going down | NO | |
| timeup | Date and time the service came back up or will be coming back up | NO | |
| scheduled | Flag whether the outage was scheduled or not | NO | |
| degraded | Flag whether the outage was degraded or not | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.its.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.its.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/its/service-notes[/:service_notes_id]"
}
}
"AutoID": "",
"ShortDesc": "Short service note description",
"LongDesc": "Long service note description",
"EndDate": "Date service note will display through",
"timedown": "Date and time the service went down or is going down",
"timeup": "Date and time the service came back up or will be coming back up",
"scheduled": "Flag whether the outage was scheduled or not",
"degraded": "Flag whether the outage was degraded or not"
}
PATCH /its/service-notes[/:service_notes_id]
Updates an existing service note. All fields except for AutoID are optional.
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| AutoID | NO | ||
| ShortDesc | Short service note description | YES | |
| LongDesc | Long service note description | YES | |
| EndDate | Date service note will display through | YES | |
| timedown | Date and time the service went down or is going down | NO | |
| timeup | Date and time the service came back up or will be coming back up | NO | |
| scheduled | Flag whether the outage was scheduled or not | NO | |
| degraded | Flag whether the outage was degraded or not | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.its.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.its.v1+json
application/json |
Body
{
"AutoID": "",
"ShortDesc": "Short service note description",
"LongDesc": "Long service note description",
"EndDate": "Date service note will display through",
"timedown": "Date and time the service went down or is going down",
"timeup": "Date and time the service came back up or will be coming back up",
"scheduled": "Flag whether the outage was scheduled or not",
"degraded": "Flag whether the outage was degraded or not"
}
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.its.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
{
"_links": {
"self": {
"href": "/its/service-notes[/:service_notes_id]"
}
}
"AutoID": "",
"ShortDesc": "Short service note description",
"LongDesc": "Long service note description",
"EndDate": "Date service note will display through",
"timedown": "Date and time the service went down or is going down",
"timeup": "Date and time the service came back up or will be coming back up",
"scheduled": "Flag whether the outage was scheduled or not",
"degraded": "Flag whether the outage was degraded or not"
}
DELETE /its/service-notes[/:service_notes_id]
Deletes a service note.
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| AutoID | NO | ||
| ShortDesc | Short service note description | YES | |
| LongDesc | Long service note description | YES | |
| EndDate | Date service note will display through | YES | |
| timedown | Date and time the service went down or is going down | NO | |
| timeup | Date and time the service came back up or will be coming back up | NO | |
| scheduled | Flag whether the outage was scheduled or not | NO | |
| degraded | Flag whether the outage was degraded or not | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.its.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.its.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
LabAvailability
GET /its/lab-availability
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.its.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.its.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
Phones
GET /its/phones
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| extension | YES | ||
| building | NO | ||
| room | NO | ||
| firstName | NO | ||
| lastName | NO | ||
| department | NO | ||
| account | NO | ||
| chargeNumber | NO | ||
| license | NO | ||
| phoneType | NO | ||
| ata | NO | ||
| mac | NO | ||
| f2 | NO | ||
| userClass | NO | ||
| notes | NO | ||
| locationFor911 | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.its.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.its.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /its/phones
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| extension | YES | ||
| building | NO | ||
| room | NO | ||
| firstName | NO | ||
| lastName | NO | ||
| department | NO | ||
| account | NO | ||
| chargeNumber | NO | ||
| license | NO | ||
| phoneType | NO | ||
| ata | NO | ||
| mac | NO | ||
| f2 | NO | ||
| userClass | NO | ||
| notes | NO | ||
| locationFor911 | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.its.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.its.v1+json
application/json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.its.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /its/phones[/:phones_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| extension | YES | ||
| building | NO | ||
| room | NO | ||
| firstName | NO | ||
| lastName | NO | ||
| department | NO | ||
| account | NO | ||
| chargeNumber | NO | ||
| license | NO | ||
| phoneType | NO | ||
| ata | NO | ||
| mac | NO | ||
| f2 | NO | ||
| userClass | NO | ||
| notes | NO | ||
| locationFor911 | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.its.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.its.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /its/phones[/:phones_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| extension | YES | ||
| building | NO | ||
| room | NO | ||
| firstName | NO | ||
| lastName | NO | ||
| department | NO | ||
| account | NO | ||
| chargeNumber | NO | ||
| license | NO | ||
| phoneType | NO | ||
| ata | NO | ||
| mac | NO | ||
| f2 | NO | ||
| userClass | NO | ||
| notes | NO | ||
| locationFor911 | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.its.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.its.v1+json
application/json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.its.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /its/phones[/:phones_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| extension | YES | ||
| building | NO | ||
| room | NO | ||
| firstName | NO | ||
| lastName | NO | ||
| department | NO | ||
| account | NO | ||
| chargeNumber | NO | ||
| license | NO | ||
| phoneType | NO | ||
| ata | NO | ||
| mac | NO | ||
| f2 | NO | ||
| userClass | NO | ||
| notes | NO | ||
| locationFor911 | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.its.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.its.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
AuthCodes
GET /its/phones/auth-codes
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| authCode | YES | ||
| description | NO | ||
| first | NO | ||
| last | NO | ||
| account | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.its.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.its.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /its/phones/auth-codes
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| authCode | YES | ||
| description | NO | ||
| first | NO | ||
| last | NO | ||
| account | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.its.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.its.v1+json
application/json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.its.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /its/phones/auth-codes[/:auth_codes_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| authCode | YES | ||
| description | NO | ||
| first | NO | ||
| last | NO | ||
| account | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.its.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.its.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /its/phones/auth-codes[/:auth_codes_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| authCode | YES | ||
| description | NO | ||
| first | NO | ||
| last | NO | ||
| account | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.its.v1+json
application/hal+json
application/json |
| Content-Type | application/vnd.its.v1+json
application/json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.its.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /its/phones/auth-codes[/:auth_codes_id]
Fields
| Field | Type | Description | Required |
|---|---|---|---|
| authCode | YES | ||
| description | NO | ||
| first | NO | ||
| last | NO | ||
| account | NO |
Request
Headers
| Header | Value |
|---|---|
| Accept | application/vnd.its.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
Headers
| Header | Value |
|---|---|
| Content-Type | application/vnd.its.v1+json
application/hal+json
application/json |
| Allow | Comma-separated list of all HTTP methods allowed |