Integratec API Platform
callResource-permits

Description

Manages resources rooted at the permit catalog.

Example

Request

This request adds a permit.

{
"method": "resourceAdd",
"params": [
[
"permits"
],
[
"name",
"PERMITNO",
"MAILINGPO",
"PREPNAME",
"HOLDERID",
"PREPAREID",
"AGENTID",
"PERMITTYPE",
"PAYACCTNO"
],
[
"99",
"Rochester NY 14692",
"XYZ Co",
"XYZ Co",
"12345678",
"456789",
"789456",
"1",
"1234567890"
]
]
}

Reply

result is the ID of the new permit.

{
"result": "9312979369"
}

Request Schema

{
"$schema":"http://json-schema.org/draft-04/schema#",
"description":"Makes a resource Remote Procedure Call (RPC) for resources.",
"definitions":{
"objectOrString":{
"oneOf":[
{
"type":"object"
},
{
"type":"string"
}
]
},
"resourceNames":{
"type":"array",
"items":{
"type":"string",
"minLength":1
}
},
"resourceId":{
"type":"array",
"minItems":1,
"maxItems":4,
"items":{
"type":"string",
"minLength":1
}
},
"resourceValues":{
"type":"array",
"items":{
"$ref":"#/definitions/scalarOrNull"
}
},
"scalarOrNull":{
"oneOf":[
{
"type":[
"boolean",
"integer",
"null",
"number",
"string"
]
},
{
"type":"object",
"required":[
"dateTime"
],
"properties":{
"dateTime":{
"type":"string",
"pattern":"^([0-9]{4})-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])([T]([01][0-9]|2[0-3]):([0-5][0-9])(:([0-5][0-9])(\\.[0-9]{1,3})?)?)?$"
}
}
}
]
}
},
"type":"object",
"oneOf":[
{
"description":"RPC parameters for resourceAdd()",
"type":"object",
"required":[
"method",
"params"
],
"properties":{
"method":{
"title":"Method",
"description":"Method name.",
"enum":[
"resourceAdd"
]
},
"params":{
"title":"Parameters",
"oneOf":[
{
"description":"Parameters to pass to resourceAdd(array resourceId, object resource).",
"type":"array",
"minItems":2,
"items":[
{
"$ref":"#/definitions/resourceId"
},
{
"$ref":"#/definitions/objectOrString"
}
],
"additionalItems":false
},
{
"description":"Parameters to pass to resourceAdd(array resourceId, array names, array values).",
"type":"array",
"minItems":3,
"items":[
{
"$ref":"#/definitions/resourceId"
},
{
"$ref":"#/definitions/resourceNames"
},
{
"$ref":"#/definitions/resourceValues"
}
],
"additionalItems":false
},
{
"description":"Parameters to pass to resourceAdd(array resourceId, array resources).",
"type":"array",
"minItems":2,
"items":[
{
"$ref":"#/definitions/resourceId"
},
{
"type":"array",
"items":{
"type":"object"
}
}
],
"additionalItems":false
}
]
}
},
"additionalProperties":false
},
{
"description":"RPC parameters for resourceDelete().",
"type":"object",
"required":[
"method",
"params"
],
"properties":{
"method":{
"title":"Method",
"description":"Method name.",
"enum":[
"resourceDelete"
]
},
"params":{
"title":"Parameters",
"description":"Parameters to pass to resourceDelete(array resourceId).",
"type":"array",
"minItems":1,
"items":[
{
"$ref":"#/definitions/resourceId"
}
],
"additionalItems":false
}
},
"additionalProperties":false
},
{
"description":"RPC parameters for resourceFind().",
"type":"object",
"required":[
"method",
"params"
],
"properties":{
"method":{
"title":"Method",
"description":"Method name.",
"enum":[
"resourceFind"
]
},
"params":{
"title":"Parameters",
"description":"Parameters to pass to resourceFind(array resourceId, array findNames, array findValues, array names).",
"type":"array",
"minItems":3,
"items":[
{
"$ref":"#/definitions/resourceId"
},
{
"$ref":"#/definitions/resourceNames"
},
{
"$ref":"#/definitions/resourceValues"
},
{
"$ref":"#/definitions/resourceNames"
}
],
"additionalItems":false
}
},
"additionalProperties":false
},
{
"description":"RPC parameters for resourceGet().",
"type":"object",
"required":[
"method",
"params"
],
"properties":{
"method":{
"title":"Method",
"description":"Method name.",
"enum":[
"resourceGet"
]
},
"params":{
"title":"Parameters",
"oneOf":[
{
"description":"Parameters to pass to resourceGet(array resourceId, array names).",
"type":"array",
"minItems":1,
"items":[
{
"$ref":"#/definitions/resourceId"
},
{
"$ref":"#/definitions/resourceNames"
}
],
"additionalItems":false
},
{
"description":"Parameters to pass to resourceGet(array resourceId, boolean forwards, string bookmark, integer count, array names).",
"type":"array",
"minItems":3,
"items":[
{
"$ref":"#/definitions/resourceId"
},
{
"type":"boolean"
},
{
"type":"string"
},
{
"type":"integer",
"minimum":-1
},
{
"$ref":"#/definitions/resourceNames"
}
],
"additionalItems":false
}
]
}
},
"additionalProperties":false
},
{
"description":"RPC parameters for resourcePut()",
"type":"object",
"required":[
"method",
"params"
],
"properties":{
"method":{
"title":"Method",
"description":"Method name.",
"enum":[
"resourcePut"
]
},
"params":{
"title":"Parameters",
"oneOf":[
{
"description":"Parameters to pass to resourcePut(array resourceId, object resource).",
"type":"array",
"minItems":2,
"items":[
{
"$ref":"#/definitions/resourceId"
},
{
"$ref":"#/definitions/objectOrString"
}
],
"additionalItems":false
},
{
"description":"Parameters to pass to resourcePut(array resourceId, array names, array values).",
"type":"array",
"minItems":3,
"items":[
{
"$ref":"#/definitions/resourceId"
},
{
"$ref":"#/definitions/resourceNames"
},
{
"$ref":"#/definitions/resourceValues"
}
],
"additionalItems":false
}
]
}
},
"additionalProperties":false
},
{
"description":"RPC parameters for resourceSet()",
"type":"object",
"required":[
"method",
"params"
],
"properties":{
"method":{
"title":"Method",
"description":"Method name.",
"enum":[
"resourceSet"
]
},
"params":{
"title":"Parameters",
"oneOf":[
{
"description":"Parameters to pass to resourceSet(array resourceId, array names, array values).",
"type":"array",
"minItems":2,
"items":[
{
"$ref":"#/definitions/resourceId"
},
{
"$ref":"#/definitions/objectOrString"
}
],
"additionalItems":false
},
{
"description":"Parameters to pass to resourceSet(array resourceId, array names, array values).",
"type":"array",
"minItems":3,
"items":[
{
"$ref":"#/definitions/resourceId"
},
{
"$ref":"#/definitions/resourceNames"
},
{
"$ref":"#/definitions/resourceValues"
}
],
"additionalItems":false
}
]
}
},
"additionalProperties":false
}
]
}

Reply Schema

{
"$schema":"http://json-schema.org/draft-04/schema#",
"definitions":{
"dateTime":{
"type":"object",
"required":[
"dateTime"
],
"properties":{
"dateTime":{
"type":"string",
"minLength":1
}
}
},
"scalarOrNull":{
"oneOf":[
{
"type":[
"boolean",
"integer",
"null",
"number",
"string"
]
},
{
"$ref":"#/definitions/dateTime"
}
]
}
},
"type":"object",
"required":[
"result"
],
"properties":{
"result":{
"title":"Result",
"description":"Result of the RPC.",
"oneOf":[
{
"type":"object"
},
{
"$ref":"#/definitions/scalarOrNull"
},
{
"type":"array",
"items": {
"$ref":"#/definitions/scalarOrNull"
}
}
]
}
},
"additionalProperties":false
}