Create a technician's access off day
post
/crmRestApi/resources/11.13.18.05/serviceTechnicianAccessSchedules/{AccScheduleNumber}/child/offdays
Request
Path Parameters
-
AccScheduleNumber(required): string
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AccScheduleId: integer
(int64)
Title:
Access Schedule ID
The unique identifier of the access schedule. -
ActiveFlag: boolean
Title:
Active
Maximum Length:1
Default Value:true
Indicates whether this technician access off days is active. -
Comments: string
Title:
Comments
Maximum Length:60
Comments for the access off day. -
DayOfWeekCd: string
Title:
Day of Week Code
Maximum Length:30
The code that identifies the day of the week for the access off day. -
DayOfWeekOccurrenceCd: string
Title:
Monthly Occurrence Code
Maximum Length:30
The code that identifies the occurrence to calculate date by in a month for the access off day. -
Label: string
Title:
Name
Maximum Length:60
The label for the off day. -
OffDay: integer
(int32)
Title:
Day
The day of the month on which the field service resource isn't allowed to be on the customer site. -
OffMonthCd: string
Title:
Month Code
Maximum Length:30
The digits representing month of the year the field service resource isn't allowed to be on the customer site. -
OffYear: integer
(int32)
Title:
Year
The four digit year the field service resource isn't allowed to be on the customer site. -
OverrideCd: string
Title:
Override Code
Maximum Length:30
The code that identifies the type of override applied to the technician's access off day. -
OverrideServiceProfileId: integer
(int64)
Title:
Service Profile ID
The unique identifier for the service profile that overrides the technician's access off day. -
OverrideWoId: integer
(int64)
Title:
Work Order ID
The unique identifier for the work order that overrides the technician's access off day. -
SchedOffdaysId: integer
(int64)
Title:
Schedule off Day ID
The unique identifier of the technician's access off day.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : serviceTechnicianAccessSchedules-offdays-item-response
Type:
Show Source
object
-
AccScheduleId: integer
(int64)
Title:
Access Schedule ID
The unique identifier of the access schedule. -
AccScheduleName: string
Title:
Schedule Name
Read Only:true
Maximum Length:50
The name of the access schedule. -
AccScheduleNumber: string
Title:
Schedule Number
Read Only:true
Maximum Length:30
The alternate unique identifier of the access schedule. -
ActiveFlag: boolean
Title:
Active
Maximum Length:1
Default Value:true
Indicates whether this technician access off days is active. -
Comments: string
Title:
Comments
Maximum Length:60
Comments for the access off day. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the technician's access off day. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the technician's access off day was created. -
DayOfWeekCd: string
Title:
Day of Week Code
Maximum Length:30
The code that identifies the day of the week for the access off day. -
DayOfWeekCdMeaning: string
Title:
Day of Week
Read Only:true
Maximum Length:255
The day of the week for the technician's access off day. -
DayOfWeekOccurrenceCd: string
Title:
Monthly Occurrence Code
Maximum Length:30
The code that identifies the occurrence to calculate date by in a month for the access off day. -
DayOfWeekOccurrenceCdMeaning: string
Title:
Monthly Occurrence
Read Only:true
Maximum Length:255
The occurrence to calculate date of a month for the access off day. -
Label: string
Title:
Name
Maximum Length:60
The label for the off day. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the technician's access off day was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the technician's access off day. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OffDate: string
(date)
Title:
Date
Read Only:true
The calculated off date. -
OffDay: integer
(int32)
Title:
Day
The day of the month on which the field service resource isn't allowed to be on the customer site. -
OffMonthCd: string
Title:
Month Code
Maximum Length:30
The digits representing month of the year the field service resource isn't allowed to be on the customer site. -
OffMonthCdMeaning: string
Title:
Month
Read Only:true
Maximum Length:255
The name of the month the field service resource isn't allowed to be on the customer site. -
OffYear: integer
(int32)
Title:
Year
The four digit year the field service resource isn't allowed to be on the customer site. -
OverrideCd: string
Title:
Override Code
Maximum Length:30
The code that identifies the type of override applied to the technician's access off day. -
OverrideCdMeaning: string
Title:
Override
Read Only:true
Maximum Length:255
The type of override applied to the technician's access off day. -
OverrideServiceProfileId: integer
(int64)
Title:
Service Profile ID
The unique identifier for the service profile that overrides the technician's access off day. -
OverrideServiceProfileName: string
Title:
Service Profile
Read Only:true
Maximum Length:400
The name of the service profile that overrides the technician's access off day. -
OverrideServiceProfileNumber: string
Title:
Service Profile Number
Read Only:true
Maximum Length:30
The public unique identifier of the service profile that overrides the technician's access off day. -
OverrideWoId: integer
(int64)
Title:
Work Order ID
The unique identifier for the work order that overrides the technician's access off day. -
OverrideWoNumber: string
Title:
Work Order Number
Read Only:true
Maximum Length:30
The public unique identifier of the work order that overrides the technician's access off day. -
SchedOffdaysId: integer
(int64)
Title:
Schedule off Day ID
The unique identifier of the technician's access off day.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.