Jump to

• Request
• Response

Create a violation code reference group code

post

/fscmRestApi/resources/11.13.18.05/publicSectorViolationCodeReferenceGroupCodes

Request

Supported Media Types

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

Body ()

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

Root Schema : publicSectorViolationCodeReferenceGroupCodes-item

Type: object

Show Source

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

  The identifier of the agency.
• CodeReferenceCode(optional): string
  Maximum Length: 100

  The identifier of the violation code reference record.
• CodeReferenceGroupCode(optional): string
  Maximum Length: 100

  The identifier of the violation code reference group.
• 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 code reference is available for use in the 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

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "title":"Agency ID",
            "description":"The identifier of the agency.",
            "type":"integer",
            "format":"int32"
        },
        "CodeReferenceCode":{
            "description":"The identifier of the violation code reference record.",
            "type":"string",
            "maxLength":100
        },
        "CodeReferenceGroupCode":{
            "description":"The identifier of the violation code reference group.",
            "type":"string",
            "maxLength":100
        },
        "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 code reference is available for use in the 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
        },
        "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 : publicSectorViolationCodeReferenceGroupCodes-item

Type: object

Show Source

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

  The identifier of the agency.
• CodeReferenceCode(optional): string
  Maximum Length: 100

  The identifier of the violation code reference record.
• CodeReferenceGroupCode(optional): string
  Maximum Length: 100

  The identifier of the violation code reference group.
• 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 code reference is available for use in the 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

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "title":"Agency ID",
            "description":"The identifier of the agency.",
            "type":"integer",
            "format":"int32"
        },
        "CodeReferenceCode":{
            "description":"The identifier of the violation code reference record.",
            "type":"string",
            "maxLength":100
        },
        "CodeReferenceGroupCode":{
            "description":"The identifier of the violation code reference group.",
            "type":"string",
            "maxLength":100
        },
        "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 code reference is available for use in the 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
        },
        "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