REL documentation
Resource:Collection: of handlerparameterC# Rel Const:Rels.MasterSvc.HandlerParametersURI template:handlerparameters{?handler,name}Obtain URI from:
get a list of handler parameter records. Note, the combination of handler and name should uniquely identify a single handler parameter record.
Success status: 200
| Name | Data Type | Description |
|---|---|---|
| handler | string | |
| name | string |
| Type | Description | |
|---|---|---|
| ResourceList | IList<Master.Models.HandlerParameter> | |
| Handler | string | This, combined with 'Name', is a candidate key to this resource |
| Name | string | This, combined with 'Handler', is a candidate key to this resource |
| Value | string | |
| Type | Master.Models.HandlerParameterType | |
| - 0: Boolean | ||
| - 1: DateTime | ||
| - 2: Int32 | ||
| - 3: String |
{
"_embedded": {
"http://api.3plCentral.com/rels/master/handlerparameter": [
{
"handler": "str",
"name": "str",
"value": "str",
"type": 0
}
]
}
}
create a new handler parameter record
Success status: 201
| Type | Description | |
|---|---|---|
| Handler | string | This, combined with 'Name', is a candidate key to this resource |
| Name | string | This, combined with 'Handler', is a candidate key to this resource |
| Value | string | |
| Type | Master.Models.HandlerParameterType | |
| - 0: Boolean | ||
| - 1: DateTime | ||
| - 2: Int32 | ||
| - 3: String |
Sample content-type: application/hal+json |
{
"handler": "str",
"name": "str",
"value": "str",
"type": 0
}
| Type | Description | |
|---|---|---|
| Handler | string | This, combined with 'Name', is a candidate key to this resource |
| Name | string | This, combined with 'Handler', is a candidate key to this resource |
| Value | string | |
| Type | Master.Models.HandlerParameterType | |
| - 0: Boolean | ||
| - 1: DateTime | ||
| - 2: Int32 | ||
| - 3: String |
{
"handler": "str",
"name": "str",
"value": "str",
"type": 0
}
This documentation is subject to change, and is updated often and without warning. The models documented may or may not be available to users now or in the future. Use this documentation at your own risk.
Contact api@3plcentral.com with any questions about this documentation.