POST service/intervals

Creates new service interval

Note: Log in to check if your API client have access to run this resource
Version: 10
Success HTTP Status Code: 201

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold is required/mandatory.

Format:
1
<ServiceInterval>
2
     <Name
Name

Required/mandatory field

Name of the service interval

>
{String}</Name>
3
     <Interval
Interval

This field is optional.

>
4
          <Value
Value

Length/quantity/value of the interval

This field is optional.

>
{Decimal}</Value>
5
          <Unit
Unit

Unit of the interval

Applicable domain values can be found here when logged in

This field is optional.

>
{String}</Unit>
6
     </Interval>
7
</ServiceInterval>
1
{
2
     "serviceInterval": {
3
          "name
Name

Required/mandatory field

Name of the service interval

":
"{String}",
4
          "interval
Interval

This field is optional.

":
{
5
               "value
Value

Length/quantity/value of the interval

This field is optional.

":
"{Decimal}",
6
               "unit
Unit

Unit of the interval

Applicable domain values can be found here when logged in

This field is optional.

":
"{String}"
7
          }
8
     }
9
}

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$showDomainDescriptions Boolean, optional Use to show an additional descriptional field for fields that are using Domain Values.
$db String, optional Set the database to use for the request
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "json"
$lang String, optional Use to get localized responses. Supported formats are 3-letter ISO-639-1 [lll], 2-letter ISO-639-2 [ll], or a combination of a two-letter language code and a two-letter country code ISO-639-2 and ISO-3166-1 [ll_CC], [ll-CC]
$useMinimumVersion Integer, optional This can be used to test a new version of a resource when your ApiClient is running an older, deprecated, version of a resource. $useminimumversion can be used to test against a newer version of the resource. See the Deprecated APIs page for more information about this.

See the page about filters and sorting on how to use filter parameters and named filters.

See the page about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<ServiceInterval>
2
     <ServiceIntervalId
ServiceIntervalId

Service interval identifier

>
{Integer}</ServiceIntervalId>
3
     <Status
Status

Status of service interval

Possible domain values can be found here when logged in

>
{Integer}</Status>
4
     <CreatedAt
CreatedAt

Date and time of creation

>
{Datetime}</CreatedAt>
5
     <Name
Name

Name of the service interval

>
{String}</Name>
6
     <UsageCount>{}</UsageCount>
7
     <Interval>
8
          <Value
Value

Length/quantity/value of the interval

>
{Decimal}</Value>
9
          <Unit
Unit

Unit of the interval

Possible domain values can be found here when logged in

>
{String}</Unit>
10
     </Interval>
11
</ServiceInterval>
1
{
2
     "serviceInterval": {
3
          "serviceIntervalId
ServiceIntervalId

Service interval identifier

":
"{Integer}",
4
          "status
Status

Status of service interval

Possible domain values can be found here when logged in

":
"{Integer}",
5
          "createdAt
CreatedAt

Date and time of creation

":
"{Datetime}",
6
          "name
Name

Name of the service interval

":
"{String}",
7
          "usageCount": "{}",
8
          "interval": {
9
               "value
Value

Length/quantity/value of the interval

":
"{Decimal}",
10
               "unit
Unit

Unit of the interval

Possible domain values can be found here when logged in

":
"{String}"
11
          }
12
     }
13
}

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 103899 HTTP 400 Name is mandatory for service interval.
Error 103905 HTTP 400 Missing service interval id.
Error 103886 HTTP 404 Service interval not found
Error 104035 HTTP 400 You can not change service interval which is deactivated.
Error 103900 HTTP 400 There is already an active service interval with given name.
Error 103906 HTTP 400 Service interval value must be greater than 0.