Jump to

• Request
• Response

Update a contact type

patch

/fscmRestApi/resources/11.13.18.05/publicSectorContactTypes/{publicSectorContactTypesUniqID}

Request

Path Parameters

• publicSectorContactTypesUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- ContactType and AgencyId ---for the Contact Types resource and used to uniquely identify an instance of Contact Types. The client should not generate the hash key value. Instead, the client should query on the Contact Types collection resource with a filter on the primary key values in order to navigate to a specific instance of Contact Types.
  
  For example: publicSectorContactTypes?q=ContactType=<value1>;AgencyId=<value2>

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• BlAccess: string
  Title: Business and License Access

  Maximum Length: 30

  Default Value: ORA_CONTACT_ACCESS_NONE

  The contact type access for business license application.
• ContactTypeName: string
  Title: Contact Type

  Maximum Length: 50

  The short description of the contact type.
• DeletedFlag: string
  Maximum Length: 1

  Default Value: N

  Indicates whether the record is logically deleted. Valid values are Y for a deleted record and N for an active record. The default value is N.
• Description: string
  Title: Description

  Maximum Length: 100

  The description of the contact type.
• EnabledFlag: string
  Title: Enabled

  Maximum Length: 1

  Indicates whether the contact type is active. If the value is Y, the contact type is active.
• PermitAccess: string
  Title: Permit Access

  Maximum Length: 30

  Default Value: ORA_CONTACT_ACCESS_NONE

  The contact type access for permit application.
• PlanningAccess: string
  Title: Planning Access

  Maximum Length: 30

  Default Value: ORA_CONTACT_ACCESS_NONE

  The contact type access for planning application.
• SeedDataLock: integer (int32)
  Default Value: 0

  Indicates whether the row is seed data. Valid values are 0 for data that is customer data, 1 for seed data that can't be modified, and 2 for seed data that can be modified.

{
    "type":"object",
    "properties":{
        "Description":{
            "title":"Description",
            "maxLength":"100",
            "type":"string",
            "description":"The description of the contact type.",
            "nullable":false
        },
        "BlAccess":{
            "title":"Business and License Access",
            "maxLength":"30",
            "type":"string",
            "description":"The contact type access for business license application.",
            "nullable":false,
            "default":"ORA_CONTACT_ACCESS_NONE"
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"Indicates whether the row is seed data. Valid values are 0 for data that is customer data, 1 for seed data that can't be modified, and 2 for seed data that can be modified.",
            "format":"int32",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"1"
            }
        },
        "DeletedFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the record is logically deleted. Valid values are Y for a deleted record and N for an active record. The default value is N.",
            "nullable":false,
            "default":"N"
        },
        "PlanningAccess":{
            "title":"Planning Access",
            "maxLength":"30",
            "type":"string",
            "description":"The contact type access for planning application.",
            "nullable":false,
            "default":"ORA_CONTACT_ACCESS_NONE"
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the contact type is active. If the value is Y, the contact type is active.",
            "nullable":false
        },
        "ContactTypeName":{
            "title":"Contact Type",
            "maxLength":"50",
            "type":"string",
            "description":"The short description of the contact type.",
            "nullable":false
        },
        "PermitAccess":{
            "title":"Permit Access",
            "maxLength":"30",
            "type":"string",
            "description":"The contact type access for permit application.",
            "nullable":false,
            "default":"ORA_CONTACT_ACCESS_NONE"
        }
    }
}

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 : publicSectorContactTypes-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Default Value: 1

  The agency identifier of the contact type.
• BlAccess: string
  Title: Business and License Access

  Maximum Length: 30

  Default Value: ORA_CONTACT_ACCESS_NONE

  The contact type access for business license application.
• ContactType: string
  Title: Contact Type Code

  Maximum Length: 30

  The contact type name.
• ContactTypeName: string
  Title: Contact Type

  Maximum Length: 50

  The short description of the contact type.
• CreationDate: string (date-time)
  Read Only: true

  The date and time that the contact type was created.
• DeletedFlag: string
  Maximum Length: 1

  Default Value: N

  Indicates whether the record is logically deleted. Valid values are Y for a deleted record and N for an active record. The default value is N.
• Description: string
  Title: Description

  Maximum Length: 100

  The description of the contact type.
• EnabledFlag: string
  Title: Enabled

  Maximum Length: 1

  Indicates whether the contact type is active. If the value is Y, the contact type is active.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the contact type was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PermitAccess: string
  Title: Permit Access

  Maximum Length: 30

  Default Value: ORA_CONTACT_ACCESS_NONE

  The contact type access for permit application.
• PlanningAccess: string
  Title: Planning Access

  Maximum Length: 30

  Default Value: ORA_CONTACT_ACCESS_NONE

  The contact type access for planning application.
• SeedDataLock: integer (int32)
  Default Value: 0

  Indicates whether the row is seed data. Valid values are 0 for data that is customer data, 1 for seed data that can't be modified, and 2 for seed data that can be modified.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date and time that the contact type was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "ContactType":{
            "title":"Contact Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The contact type name.",
            "nullable":false,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"100",
            "type":"string",
            "description":"The description of the contact type.",
            "nullable":false,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The agency identifier of the contact type.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"Indicates whether the row is seed data. Valid values are 0 for data that is customer data, 1 for seed data that can't be modified, and 2 for seed data that can be modified.",
            "format":"int32",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"1"
            },
            "x-queryable":true
        },
        "PermitAccess":{
            "title":"Permit Access",
            "maxLength":"30",
            "type":"string",
            "description":"The contact type access for permit application.",
            "nullable":false,
            "default":"ORA_CONTACT_ACCESS_NONE",
            "x-queryable":true
        },
        "BlAccess":{
            "title":"Business and License Access",
            "maxLength":"30",
            "type":"string",
            "description":"The contact type access for business license application.",
            "nullable":false,
            "default":"ORA_CONTACT_ACCESS_NONE",
            "x-queryable":true
        },
        "DeletedFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the record is logically deleted. Valid values are Y for a deleted record and N for an active record. The default value is N.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PlanningAccess":{
            "title":"Planning Access",
            "maxLength":"30",
            "type":"string",
            "description":"The contact type access for planning application.",
            "nullable":false,
            "default":"ORA_CONTACT_ACCESS_NONE",
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the contact type is active. If the value is Y, the contact type is active.",
            "nullable":false,
            "x-queryable":true
        },
        "ContactTypeName":{
            "title":"Contact Type",
            "maxLength":"50",
            "type":"string",
            "description":"The short description of the contact type.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the contact type was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "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