Create an inspection calendar
post
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionCalendars
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorInspectionCalendars-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
The agency identifier of the public sector entity to which this inspection calendar applies. -
BetwRecurNum(optional):
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(optional):
string
Title:
Calendar ID
Maximum Length:30
The unique identifier for the inspection calendar. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The user who created the inspection calendar. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time that the inspection calendar was created. -
Description(optional):
string
Title:
Description
Maximum Length:100
The description of the inspection calendar. -
DistrictId(optional):
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(optional):
string
Maximum Length:
1
Indicates that the inspector is available to be assigned on Friday. -
InspectionType(optional):
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. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date and time that the inspection calendar was last modified. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who last modified the inspection calendar. -
links(optional):
array Items
Title:
Items
Link Relations -
MonFlag(optional):
string
Maximum Length:
1
Indicates that the inspector is available to be assigned on Monday. -
Recurrence(optional):
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(optional):
string
Maximum Length:
1
Indicates that the inspector is available to be assigned on Saturday. -
SunFlag(optional):
string
Maximum Length:
1
Indicates that the inspector is available to be assigned on Sunday. -
ThuFlag(optional):
string
Maximum Length:
1
Indicates that the inspector is available to be assigned on Thursday. -
TimeFrom(optional):
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(optional):
string
Title:
Time
Maximum Length:255
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(optional):
string(date-time)
Title:
End Time
The end time after which any inspectors using this inspection calendar are no longer available. -
TueFlag(optional):
string
Maximum Length:
1
Indicates that the inspector is available to be assigned on Tuesday. -
ValidFromDate(optional):
string(date)
Title:
Start Date
The start date on which the inspection calendar becomes effective. -
ValidToDate(optional):
string(date)
Title:
End Date
The end date after which the inspection calendar is no longer effective. -
WedFlag(optional):
string
Maximum Length:
1
Indicates that the inspector is available to be assigned on Wednesday.
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorInspectionCalendars-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
Title:
Agency ID
The agency identifier of the public sector entity to which this inspection calendar applies. -
BetwRecurNum(optional):
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(optional):
string
Title:
Calendar ID
Maximum Length:30
The unique identifier for the inspection calendar. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The user who created the inspection calendar. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time that the inspection calendar was created. -
Description(optional):
string
Title:
Description
Maximum Length:100
The description of the inspection calendar. -
DistrictId(optional):
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(optional):
string
Maximum Length:
1
Indicates that the inspector is available to be assigned on Friday. -
InspectionType(optional):
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. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date and time that the inspection calendar was last modified. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who last modified the inspection calendar. -
links(optional):
array Items
Title:
Items
Link Relations -
MonFlag(optional):
string
Maximum Length:
1
Indicates that the inspector is available to be assigned on Monday. -
Recurrence(optional):
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(optional):
string
Maximum Length:
1
Indicates that the inspector is available to be assigned on Saturday. -
SunFlag(optional):
string
Maximum Length:
1
Indicates that the inspector is available to be assigned on Sunday. -
ThuFlag(optional):
string
Maximum Length:
1
Indicates that the inspector is available to be assigned on Thursday. -
TimeFrom(optional):
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(optional):
string
Title:
Time
Maximum Length:255
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(optional):
string(date-time)
Title:
End Time
The end time after which any inspectors using this inspection calendar are no longer available. -
TueFlag(optional):
string
Maximum Length:
1
Indicates that the inspector is available to be assigned on Tuesday. -
ValidFromDate(optional):
string(date)
Title:
Start Date
The start date on which the inspection calendar becomes effective. -
ValidToDate(optional):
string(date)
Title:
End Date
The end date after which the inspection calendar is no longer effective. -
WedFlag(optional):
string
Maximum Length:
1
Indicates that the inspector is available to be assigned on Wednesday.
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.