Jump to

• Request
• Response

Create a violation notice type in a violation notice group

post

/fscmRestApi/resources/11.13.18.05/publicSectorViolationNoticeGroups/{publicSectorViolationNoticeGroupsUniqID}/child/NoticeMappings

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Path Parameters

• publicSectorViolationNoticeGroupsUniqID: integer
  This is the hash key of the attributes which make up the composite key--- AgencyId and NoticeGroupCode ---for the Violation Notice Groups resource and used to uniquely identify an instance of Violation Notice Groups. The client should not generate the hash key value. Instead, the client should query on the Violation Notice Groups collection resource with a filter on the primary key values in order to navigate to a specific instance of Violation Notice Groups.
  
  For example: publicSectorViolationNoticeGroups?q=AgencyId=<value1>;NoticeGroupCode=<value2>

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorViolationNoticeGroups-NoticeMappings-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  The identifier of the agency.
• CaseStatus(optional): string
  Maximum Length: 15

  The status of the case record.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The name of the user who created the row.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date and time when the row was created.
• EnabledFlag(optional): boolean
  Title: Enabled

  Indicates whether the violation notice type is available for use in the violation notice group.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date and time when the row was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The name of the user who last updated the row.
• links(optional): array Items
  Title: Items

  Link Relations
• NoticeCount(optional): integer(int32)
  The sequence of the notice record.
• NoticeGroupCode(optional): string
  Maximum Length: 100

  The violation notice group code of the record.
• NoticeTypeCode(optional): string
  Maximum Length: 100

  The violation notice type code of the record.
• NoticeTypeName(optional): string
  Maximum Length: 255

  The name of the notice type associated with the notice group.
• StatusName(optional): string
  Maximum Length: 255

  The status name of the record.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "title":"Agency ID",
            "description":"The identifier of the agency.",
            "type":"integer",
            "format":"int32"
        },
        "CaseStatus":{
            "description":"The status of the case record.",
            "type":"string",
            "maxLength":15
        },
        "CreatedBy":{
            "title":"Created By",
            "description":"The name of the user who created the row.",
            "type":"string",
            "maxLength":64
        },
        "CreationDate":{
            "title":"Creation Date",
            "description":"The date and time when the row was created.",
            "type":"string",
            "format":"date-time"
        },
        "EnabledFlag":{
            "title":"Enabled",
            "description":"Indicates whether the violation notice type is available for use in the violation notice group.",
            "type":"boolean"
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "description":"The date and time when the row was last updated.",
            "type":"string",
            "format":"date-time"
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "description":"The name of the user who last updated the row.",
            "type":"string",
            "maxLength":64
        },
        "NoticeCount":{
            "description":"The sequence of the notice record.",
            "type":"integer",
            "format":"int32"
        },
        "NoticeGroupCode":{
            "description":"The violation notice group code of the record.",
            "type":"string",
            "maxLength":100
        },
        "NoticeTypeCode":{
            "description":"The violation notice type code of the record.",
            "type":"string",
            "maxLength":100
        },
        "NoticeTypeName":{
            "description":"The name of the notice type associated with the notice group.",
            "type":"string",
            "maxLength":255
        },
        "StatusName":{
            "description":"The status name of the record.",
            "type":"string",
            "maxLength":255
        },
        "links":{
            "title":"Items",
            "description":"Link Relations",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "title":"Items",
    "description":"Link Relations",
    "type":"array",
    "items":{
        "$ref":"#/definitions/link"
    }
}

Nested Schema : link

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "href":{
            "title":"hyperlink reference",
            "description":"The URI to the related resource.",
            "type":"string"
        },
        "rel":{
            "title":"relation",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorViolationNoticeGroups-NoticeMappings-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  The identifier of the agency.
• CaseStatus(optional): string
  Maximum Length: 15

  The status of the case record.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The name of the user who created the row.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date and time when the row was created.
• EnabledFlag(optional): boolean
  Title: Enabled

  Indicates whether the violation notice type is available for use in the violation notice group.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date and time when the row was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The name of the user who last updated the row.
• links(optional): array Items
  Title: Items

  Link Relations
• NoticeCount(optional): integer(int32)
  The sequence of the notice record.
• NoticeGroupCode(optional): string
  Maximum Length: 100

  The violation notice group code of the record.
• NoticeTypeCode(optional): string
  Maximum Length: 100

  The violation notice type code of the record.
• NoticeTypeName(optional): string
  Maximum Length: 255

  The name of the notice type associated with the notice group.
• StatusName(optional): string
  Maximum Length: 255

  The status name of the record.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "title":"Agency ID",
            "description":"The identifier of the agency.",
            "type":"integer",
            "format":"int32"
        },
        "CaseStatus":{
            "description":"The status of the case record.",
            "type":"string",
            "maxLength":15
        },
        "CreatedBy":{
            "title":"Created By",
            "description":"The name of the user who created the row.",
            "type":"string",
            "maxLength":64
        },
        "CreationDate":{
            "title":"Creation Date",
            "description":"The date and time when the row was created.",
            "type":"string",
            "format":"date-time"
        },
        "EnabledFlag":{
            "title":"Enabled",
            "description":"Indicates whether the violation notice type is available for use in the violation notice group.",
            "type":"boolean"
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "description":"The date and time when the row was last updated.",
            "type":"string",
            "format":"date-time"
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "description":"The name of the user who last updated the row.",
            "type":"string",
            "maxLength":64
        },
        "NoticeCount":{
            "description":"The sequence of the notice record.",
            "type":"integer",
            "format":"int32"
        },
        "NoticeGroupCode":{
            "description":"The violation notice group code of the record.",
            "type":"string",
            "maxLength":100
        },
        "NoticeTypeCode":{
            "description":"The violation notice type code of the record.",
            "type":"string",
            "maxLength":100
        },
        "NoticeTypeName":{
            "description":"The name of the notice type associated with the notice group.",
            "type":"string",
            "maxLength":255
        },
        "StatusName":{
            "description":"The status name of the record.",
            "type":"string",
            "maxLength":255
        },
        "links":{
            "title":"Items",
            "description":"Link Relations",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "title":"Items",
    "description":"Link Relations",
    "type":"array",
    "items":{
        "$ref":"#/definitions/link"
    }
}

Nested Schema : link

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "href":{
            "title":"hyperlink reference",
            "description":"The URI to the related resource.",
            "type":"string"
        },
        "rel":{
            "title":"relation",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "type":"string"
        }
    }
}

Back to Top