Jump to

• Request
• Response

Get all technicians' access off days

get

/crmRestApi/resources/11.13.18.05/serviceTechnicianAccessOffDays

Request

Query Parameters

• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • PrimaryKey Finds a technician's access off days by primary key.
    Finder Variables
    • SchedOffdaysId; integer; The unique identifier of the technician's access off day.
  • byAccessScheduleFinder Finds a technician's access off days by data.
    Finder Variables
    • bindAccessScheduleId; integer; The unique identifier of the access schedule.
    • bindAccessScheduleNumber; string; The public unique identifier of the technician access schedule.
    • bindAccountPartyId; integer; The unique identifier of the account party for the access off days.
    • bindCountryCd; string; The country code for the technician's access off days.
    • bindRegion; string; The region of country for the technician's access off days.
    • bindServiceProfileId; integer; The unique identifier of the service profile for the access off days.
    • bindWoId; integer; The unique identifier of the work order for the technician's access off days.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AccScheduleId; integer; The unique identifier of the access schedule.
  • AccScheduleName; string; The name of the access schedule.
  • AccScheduleNumber; string; The alternate unique identifier of the access schedule.
  • ActiveFlag; boolean; Indicates whether this technician access off days is active.
  • Comments; string; Comments for the access off day.
  • CreatedBy; string; The user who created the technician's access off day.
  • CreationDate; string; The date and time when the technician's access off day was created.
  • DayOfWeekCd; string; The code that identifies the day of the week for the access off day.
  • DayOfWeekCdMeaning; string; The day of the week for the technician's access off day.
  • DayOfWeekOccurrenceCd; string; The code that identifies the occurrence to calculate date by in a month for the access off day.
  • DayOfWeekOccurrenceCdMeaning; string; The occurrence to calculate date of a month for the access off day.
  • Label; string; The label for the off day.
  • LastUpdateDate; string; The date and time when the technician's access off day was last updated.
  • LastUpdatedBy; string; The user who last updated the technician's access off day.
  • OffDay; integer; The day of the month on which the field service resource isn't allowed to be on the customer site.
  • OffMonthCd; string; The digits representing month of the year the field service resource isn't allowed to be on the customer site.
  • OffMonthCdMeaning; string; The name of the month the field service resource isn't allowed to be on the customer site.
  • OffYear; integer; The four digit year the field service resource isn't allowed to be on the customer site.
  • OverrideCd; string; The code that identifies the type of override applied to the technician's access off day.
  • OverrideCdMeaning; string; The type of override applied to the technician's access off day.
  • OverrideServiceProfileId; integer; The unique identifier for the service profile that overrides the technician's access off day.
  • OverrideServiceProfileName; string; The name of the service profile that overrides the technician's access off day.
  • OverrideServiceProfileNumber; string; The public unique identifier of the service profile that overrides the technician's access off day.
  • OverrideWoId; integer; The unique identifier for the work order that overrides the technician's access off day.
  • OverrideWoNumber; string; The public unique identifier of the work order that overrides the technician's access off day.
  • SchedOffdaysId; integer; The unique identifier of the technician's access off day.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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.

There's no request body for this operation.

Back to Top

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.

Body ()

Root Schema : serviceTechnicianAccessOffDays

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/serviceTechnicianAccessOffDays-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"OEC"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object serviceTechnicianAccessOffDays-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/serviceTechnicianAccessOffDays-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : serviceTechnicianAccessOffDays-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the technician's access off day was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OffDate":{
            "title":"Date",
            "type":"string",
            "description":"The calculated off date.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "DayOfWeekCd",
                    "DayOfWeekOccurrenceCd",
                    "OffDay",
                    "OffMonthCd",
                    "OffYear"
                ]
            }
        },
        "SchedOffdaysId":{
            "title":"Schedule off Day ID",
            "type":"integer",
            "description":"The unique identifier of the technician's access off day.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OverrideServiceProfileId":{
            "title":"Service Profile ID",
            "type":"integer",
            "description":"The unique identifier for the service profile that overrides the technician's access off day.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Label":{
            "title":"Name",
            "maxLength":"60",
            "type":"string",
            "description":"The label for the off day.",
            "nullable":false,
            "x-queryable":true
        },
        "OverrideServiceProfileName":{
            "title":"Service Profile",
            "maxLength":"400",
            "type":"string",
            "description":"The name of the service profile that overrides the technician's access off day.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OffYear":{
            "title":"Year",
            "type":"integer",
            "description":"The four digit year the field service resource isn't allowed to be on the customer site.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"4"
            },
            "x-queryable":true
        },
        "DayOfWeekOccurrenceCd":{
            "title":"Monthly Occurrence Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code that identifies the occurrence to calculate date by in a month for the access off day.",
            "nullable":false,
            "x-queryable":true
        },
        "DayOfWeekCd":{
            "title":"Day of Week Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code that identifies the day of the week for the access off day.",
            "nullable":true,
            "x-queryable":true
        },
        "OverrideCdMeaning":{
            "title":"Override",
            "maxLength":"255",
            "type":"string",
            "description":"The type of override applied to the technician's access off day.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AccScheduleId":{
            "title":"Access Schedule ID",
            "type":"integer",
            "description":"The unique identifier of the access schedule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OffDay":{
            "title":"Day",
            "type":"integer",
            "description":"The day of the month on which the field service resource isn't allowed to be on the customer site.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"2"
            },
            "x-queryable":true
        },
        "OverrideServiceProfileNumber":{
            "title":"Service Profile Number",
            "maxLength":"30",
            "type":"string",
            "description":"The public unique identifier of the service profile that overrides the technician's access off day.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DayOfWeekOccurrenceCdMeaning":{
            "title":"Monthly Occurrence",
            "maxLength":"255",
            "type":"string",
            "description":"The occurrence to calculate date of a month for the access off day.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OverrideWoId":{
            "title":"Work Order ID",
            "type":"integer",
            "description":"The unique identifier for the work order that overrides the technician's access off day.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the technician's access off day.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OffMonthCdMeaning":{
            "title":"Month",
            "maxLength":"255",
            "type":"string",
            "description":"The name of the month the field service resource isn't allowed to be on the customer site.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the technician's access off day.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OffMonthCd":{
            "title":"Month Code",
            "maxLength":"30",
            "type":"string",
            "description":"The digits representing month of the year the field service resource isn't allowed to be on the customer site.",
            "nullable":false,
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"60",
            "type":"string",
            "description":"Comments for the access off day.",
            "nullable":true,
            "x-queryable":true
        },
        "AccScheduleNumber":{
            "title":"Schedule Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate unique identifier of the access schedule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether this technician access off days is active.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "AccScheduleName":{
            "title":"Schedule Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of the access schedule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DayOfWeekCdMeaning":{
            "title":"Day of Week",
            "maxLength":"255",
            "type":"string",
            "description":"The day of the week for the technician's access off day.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OverrideCd":{
            "title":"Override Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code that identifies the type of override applied to the technician's access off day.",
            "nullable":true,
            "x-queryable":true
        },
        "OverrideWoNumber":{
            "title":"Work Order Number",
            "maxLength":"30",
            "type":"string",
            "description":"The public unique identifier of the work order that overrides the technician's access off day.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the technician's access off day was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top