Jump to

• Request
• Response

Create a terms of use definition

post

/fscmRestApi/resources/11.13.18.05/publicSectorTermsOfUses

Request

Header Parameters

• Effective-Of:
  This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
• 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:
  When set to true, the server will perform an Upsert operation instead of a Create. In an Upsert operation the server attempts to find an existing resource that matches the payload. If found, the server updates the existing resource instead of creating a new one. If not found, or when set to false (the default), a Create is performed.

Supported Media Types

• application/json

Request Body - application/json ()

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

Root Schema : schema

Type: object

Show Source

• AgencyId: integer (int32)
  Default Value: 1

  The unique identifier for an agency that is associated with a terms of use definition.
• Description(required): string
  Title: Description

  Maximum Length: 100

  The description of the terms of use definition.
• EffectiveEndDate(required): string (date)
  Title: Effective End Date

  The effective end date of the terms of use definition.
• EffectiveStartDate(required): string (date)
  Title: Effective Start Date

  The effective start date of the terms of use definition.
• TermsContent: string (byte)
  Title: Content

  The detailed content of the terms of use.
• TermsUsage: array Terms Usages
  Title: Terms Usages

  The terms usages resource is used to view, add, delete and modify the transaction types that can use a terms of use definition. Terms of use content can be enabled or disabled for use by transactions such as user registration or a permit application.
• TermsUseId(required): string
  Title: Terms of Use ID

  Maximum Length: 15

  The unique identifier for the terms of use definition.

{
    "required":[
        "Description",
        "EffectiveEndDate",
        "EffectiveStartDate",
        "TermsUseId"
    ],
    "type":"object",
    "properties":{
        "TermsContent":{
            "title":"Content",
            "type":"string",
            "description":"The detailed content of the terms of use.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":100,
            "type":"string",
            "description":"The description of the terms of use definition.",
            "nullable":false
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier for an agency that is associated with a terms of use definition.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            }
        },
        "EffectiveEndDate":{
            "title":"Effective End Date",
            "type":"string",
            "description":"The effective end date of the terms of use definition.",
            "format":"date",
            "nullable":false
        },
        "TermsUseId":{
            "title":"Terms of Use ID",
            "maxLength":15,
            "type":"string",
            "description":"The unique identifier for the terms of use definition.",
            "nullable":false
        },
        "TermsUsage":{
            "title":"Terms Usages",
            "type":"array",
            "description":"The terms usages resource is used to view, add, delete and modify the transaction types that can use a terms of use definition. Terms of use content can be enabled or disabled for use by transactions such as user registration or a permit application.",
            "items":{
                "$ref":"#/components/schemas/publicSectorTermsOfUses-TermsUsage-item-post-request"
            }
        },
        "EffectiveStartDate":{
            "title":"Effective Start Date",
            "type":"string",
            "description":"The effective start date of the terms of use definition.",
            "format":"date",
            "nullable":false
        }
    }
}

Nested Schema : Terms Usages

Type: array

Title: Terms Usages

The terms usages resource is used to view, add, delete and modify the transaction types that can use a terms of use definition. Terms of use content can be enabled or disabled for use by transactions such as user registration or a permit application.

Show Source

• Array of: object publicSectorTermsOfUses-TermsUsage-item-post-request

{
    "title":"Terms Usages",
    "type":"array",
    "description":"The terms usages resource is used to view, add, delete and modify the transaction types that can use a terms of use definition. Terms of use content can be enabled or disabled for use by transactions such as user registration or a permit application.",
    "items":{
        "$ref":"#/components/schemas/publicSectorTermsOfUses-TermsUsage-item-post-request"
    }
}

Nested Schema : publicSectorTermsOfUses-TermsUsage-item-post-request

Type: object

Show Source

• AgencyId: integer (int32)
  The unique identifier for an agency that is associated with a terms of use definition.
• EffectiveEndDate: string (date)
  The effective end date of the terms of use definition.
• EffectiveStartDate: string (date)
  The effective start date of the terms of use definition.
• EnabledFlag: string
  Maximum Length: 1

  Indicates whether the terms of use definition is enabled for the transaction type. If the value is Y, terms of use definition is enabled. The default value is N.
• Product: string
  Maximum Length: 30

  The transaction type for which the terms content is enabled or disabled.
• TermsUseId: string
  Maximum Length: 15

  The unique identifier for a terms of use definition.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier for an agency that is associated with a terms of use definition.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":8
            }
        },
        "EffectiveEndDate":{
            "type":"string",
            "description":"The effective end date of the terms of use definition.",
            "format":"date",
            "nullable":true
        },
        "Product":{
            "maxLength":30,
            "type":"string",
            "description":"The transaction type for which the terms content is enabled or disabled.",
            "nullable":false
        },
        "TermsUseId":{
            "maxLength":15,
            "type":"string",
            "description":"The unique identifier for a terms of use definition.",
            "nullable":false
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the terms of use definition is enabled for the transaction type. If the value is Y, terms of use definition is enabled. The default value is N.",
            "nullable":false
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"The effective start date of the terms of use definition.",
            "format":"date",
            "nullable":false
        }
    }
}

Back to Top

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.

Body ()

Root Schema : publicSectorTermsOfUses-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Default Value: 1

  The unique identifier for an agency that is associated with a terms of use definition.
• Description: string
  Title: Description

  Maximum Length: 100

  The description of the terms of use definition.
• EffectiveEndDate: string (date)
  Title: Effective End Date

  The effective end date of the terms of use definition.
• EffectiveStartDate: string (date)
  Title: Effective Start Date

  The effective start date of the terms of use definition.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• TermsContent: string (byte)
  Title: Content

  The detailed content of the terms of use.
• TermsUsage: array Terms Usages
  Title: Terms Usages

  The terms usages resource is used to view, add, delete and modify the transaction types that can use a terms of use definition. Terms of use content can be enabled or disabled for use by transactions such as user registration or a permit application.
• TermsUseId: string
  Title: Terms of Use ID

  Maximum Length: 15

  The unique identifier for the terms of use definition.

{
    "type":"object",
    "properties":{
        "TermsContent":{
            "title":"Content",
            "type":"string",
            "description":"The detailed content of the terms of use.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":100,
            "type":"string",
            "description":"The description of the terms of use definition.",
            "nullable":false,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier for an agency that is associated with a terms of use definition.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "EffectiveEndDate":{
            "title":"Effective End Date",
            "type":"string",
            "description":"The effective end date of the terms of use definition.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TermsUseId":{
            "title":"Terms of Use ID",
            "maxLength":15,
            "type":"string",
            "description":"The unique identifier for the terms of use definition.",
            "nullable":false,
            "x-queryable":true
        },
        "TermsUsage":{
            "title":"Terms Usages",
            "type":"array",
            "description":"The terms usages resource is used to view, add, delete and modify the transaction types that can use a terms of use definition. Terms of use content can be enabled or disabled for use by transactions such as user registration or a permit application.",
            "items":{
                "$ref":"#/components/schemas/publicSectorTermsOfUses-TermsUsage-item-response"
            }
        },
        "EffectiveStartDate":{
            "title":"Effective Start Date",
            "type":"string",
            "description":"The effective start date of the terms of use definition.",
            "format":"date",
            "nullable":false,
            "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 : Terms Usages

Type: array

Title: Terms Usages

The terms usages resource is used to view, add, delete and modify the transaction types that can use a terms of use definition. Terms of use content can be enabled or disabled for use by transactions such as user registration or a permit application.

Show Source

• Array of: object publicSectorTermsOfUses-TermsUsage-item-response

{
    "title":"Terms Usages",
    "type":"array",
    "description":"The terms usages resource is used to view, add, delete and modify the transaction types that can use a terms of use definition. Terms of use content can be enabled or disabled for use by transactions such as user registration or a permit application.",
    "items":{
        "$ref":"#/components/schemas/publicSectorTermsOfUses-TermsUsage-item-response"
    }
}

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."
        }
    }
}

Nested Schema : publicSectorTermsOfUses-TermsUsage-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  The unique identifier for an agency that is associated with a terms of use definition.
• Description: string
  Title: Description

  Read Only: true

  Maximum Length: 100

  The description of the terms of use definition.
• EffectiveEndDate: string (date)
  The effective end date of the terms of use definition.
• EffectiveStartDate: string (date)
  The effective start date of the terms of use definition.
• EnabledFlag: string
  Maximum Length: 1

  Indicates whether the terms of use definition is enabled for the transaction type. If the value is Y, terms of use definition is enabled. The default value is N.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Product: string
  Maximum Length: 30

  The transaction type for which the terms content is enabled or disabled.
• TermsUseId: string
  Maximum Length: 15

  The unique identifier for a terms of use definition.

{
    "type":"object",
    "properties":{
        "Description":{
            "title":"Description",
            "maxLength":100,
            "type":"string",
            "description":"The description of the terms of use definition.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier for an agency that is associated with a terms of use definition.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "EffectiveEndDate":{
            "type":"string",
            "description":"The effective end date of the terms of use definition.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "Product":{
            "maxLength":30,
            "type":"string",
            "description":"The transaction type for which the terms content is enabled or disabled.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TermsUseId":{
            "maxLength":15,
            "type":"string",
            "description":"The unique identifier for a terms of use definition.",
            "nullable":false,
            "x-queryable":true
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the terms of use definition is enabled for the transaction type. If the value is Y, terms of use definition is enabled. The default value is N.",
            "nullable":false,
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"The effective start date of the terms of use definition.",
            "format":"date",
            "nullable":false,
            "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"
    }
}

Links

TermsUsage

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorTermsOfUses/{publicSectorTermsOfUsesUniqID}/child/TermsUsage

Parameters:

• publicSectorTermsOfUsesUniqID: $request.path.publicSectorTermsOfUsesUniqID

The terms usages resource is used to view, add, delete and modify the transaction types that can use a terms of use definition. Terms of use content can be enabled or disabled for use by transactions such as user registration or a permit application.

Back to Top