Create an inspection calendar
post
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionCalendars
Request
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
-
AgencyId: integer
Title:
Agency ID
Default Value:1
The agency identifier of the public sector entity to which this inspection calendar applies. -
BetwRecurNum: integer
(int32)
Title:
Weeks Between Occurrences
The number of weeks between occurrences of the schedule. If Recurrence is true, this is a required field. -
CalendarId: string
Title:
Calendar ID
Maximum Length:30
The unique identifier for the inspection calendar. -
Description: string
Title:
Description
Maximum Length:100
The description of the inspection calendar. -
DistrictId: string
Title:
District
Maximum Length:30
The district identifier to which this inspection calendar applies. A list of accepted values is returned by DistrictPromptVO1. -
FriFlag: string
Maximum Length:
1
Indicates that the inspector is available to be assigned on Friday. -
InspectionType: string
Title:
Inspection Type
Maximum Length:15
The type of inspection to which this inspection calendar applies. A list of accepted values is returned by InspectionTypePVO1. -
MonFlag: string
Maximum Length:
1
Indicates that the inspector is available to be assigned on Monday. -
Recurrence: string
Title:
Recurrence
Maximum Length:3
The recurrence indicates whether the schedule repeats on a weekly basis. If true, the schedule repeats every BetwRecurNum weeks. If false, the schedule does not repeat. The default value is true. -
SatFlag: string
Maximum Length:
1
Indicates that the inspector is available to be assigned on Saturday. -
SunFlag: string
Maximum Length:
1
Indicates that the inspector is available to be assigned on Sunday. -
ThuFlag: string
Maximum Length:
1
Indicates that the inspector is available to be assigned on Thursday. -
TimeFrom: string
(date-time)
Title:
Start Time
The start time at which any inspectors using this inspection calendar are available to be assigned to an inspection. -
TimeRange: string
Title:
Time
Maximum Length:80
The time range (start time to end time) during which any inspectors using this inspection calendar are available to be assigned to an inspection. This attribute is read-only, it cannot be updated by the resource consumer. -
TimeTo: string
(date-time)
Title:
End Time
The end time after which any inspectors using this inspection calendar are no longer available. -
TueFlag: string
Maximum Length:
1
Indicates that the inspector is available to be assigned on Tuesday. -
ValidFromDate: string
(date)
Title:
Start Date
The start date on which the inspection calendar becomes effective. -
ValidToDate: string
(date)
Title:
End Date
The end date after which the inspection calendar is no longer effective. -
WedFlag: string
Maximum Length:
1
Indicates that the inspector is available to be assigned on Wednesday.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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 : publicSectorInspectionCalendars-item-response
Type:
Show Source
object
-
AgencyId: integer
Title:
Agency ID
Default Value:1
The agency identifier of the public sector entity to which this inspection calendar applies. -
BetwRecurNum: integer
(int32)
Title:
Weeks Between Occurrences
The number of weeks between occurrences of the schedule. If Recurrence is true, this is a required field. -
CalendarId: string
Title:
Calendar ID
Maximum Length:30
The unique identifier for the inspection calendar. -
Description: string
Title:
Description
Maximum Length:100
The description of the inspection calendar. -
DistrictId: string
Title:
District
Maximum Length:30
The district identifier to which this inspection calendar applies. A list of accepted values is returned by DistrictPromptVO1. -
FriFlag: string
Maximum Length:
1
Indicates that the inspector is available to be assigned on Friday. -
InspectionType: string
Title:
Inspection Type
Maximum Length:15
The type of inspection to which this inspection calendar applies. A list of accepted values is returned by InspectionTypePVO1. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MonFlag: string
Maximum Length:
1
Indicates that the inspector is available to be assigned on Monday. -
Recurrence: string
Title:
Recurrence
Maximum Length:3
The recurrence indicates whether the schedule repeats on a weekly basis. If true, the schedule repeats every BetwRecurNum weeks. If false, the schedule does not repeat. The default value is true. -
SatFlag: string
Maximum Length:
1
Indicates that the inspector is available to be assigned on Saturday. -
SunFlag: string
Maximum Length:
1
Indicates that the inspector is available to be assigned on Sunday. -
ThuFlag: string
Maximum Length:
1
Indicates that the inspector is available to be assigned on Thursday. -
TimeFrom: string
(date-time)
Title:
Start Time
The start time at which any inspectors using this inspection calendar are available to be assigned to an inspection. -
TimeRange: string
Title:
Time
Maximum Length:80
The time range (start time to end time) during which any inspectors using this inspection calendar are available to be assigned to an inspection. This attribute is read-only, it cannot be updated by the resource consumer. -
TimeTo: string
(date-time)
Title:
End Time
The end time after which any inspectors using this inspection calendar are no longer available. -
TueFlag: string
Maximum Length:
1
Indicates that the inspector is available to be assigned on Tuesday. -
ValidFromDate: string
(date)
Title:
Start Date
The start date on which the inspection calendar becomes effective. -
ValidToDate: string
(date)
Title:
End Date
The end date after which the inspection calendar is no longer effective. -
WedFlag: string
Maximum Length:
1
Indicates that the inspector is available to be assigned on Wednesday.
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.