-
+[% FOREACH f IN col.fields -%]
+
- [% f.name %] ([% f.types.join(', ') %]): [% f.description %] +[% END -%] +
+[% + cmd = 'curl -i -X OPTIONS -H \'Connection: close\' --cert NGCP-API-client-certificate.pem --cacert ca-cert.pem https://example.org:1443/api/' _ id _ '/'; + INCLUDE helpers/api_command.tt cmd=cmd level=level+3; + + request = +'OPTIONS /api/' _ id _ '/ HTTP/1.1'; + + response = +'HTTP/1.1 200 OK +Allow: GET, HEAD, OPTIONS, POST +Accept-Post: application/hal+json; profile="http://purl.org/sipwise/ngcp-api/#rel-' _ id _ '"'; + INCLUDE helpers/api_req_res.tt request=request response=response level=level+3; +-%] +
+ ++
+ You cannot request the entire collection at once, but instead you can simply page through the results. The response provides prev and next links you can follow to get the next page. + + To define the page number and the rows per page to return, you can pass the parameters page and rows. Default values are page=1 and rows=10, if you do not provide them. +
+[% + cmd = 'curl -i -X GET -H \'Connection: close\' --cert NGCP-API-client-certificate.pem --cacert ca-cert.pem \'https://example.org:1443/api/' _ id _ '/?page=1&rows=2\''; + INCLUDE helpers/api_command.tt cmd=cmd level=level+3; + + props = ' "id" : 1'; + FOREACH p IN col.fields; + NEXT IF p.types.0 == 'null'; + props = props _ ', +'; + IF p.types.0 == "Number"; + val = 4; + ELSIF p.types.0 == "String"; + val = '"test"'; + ELSIF p.types.0 == "Boolean"; + val = 'true'; + ELSIF p.types.0 == "Array"; + val = '[]'; + ELSE; + val = '"missing"'; + END; + props = props _ ' "' _ p.name _ '" : ' _ val; + END; + props = props _ ' +'; + + request = +'GET /api/' _ id _ '/?page=1&rows=1 HTTP/1.1'; + response = +'HTTP/1.1 200 OK +Content-Type: application/hal+json; profile="http://purl.org/sipwise/ngcp-api/" + +{ + "_embedded" : { + "ngcp:' _ id _ '" : [ + { + "_links" : { + "collection" : { + "href" : "/api/' _ id _ '/" + }, + "curies" : { + "href" : "http://purl.org/sipwise/ngcp-api/#rel-{rel}", + "name" : "ngcp", + "templated" : true + }, + "profile" : { + "href" : "http://purl.org/sipwise/ngcp-api/" + }, + "self" : { + "href" : "/api/' _ id _ '/1" + } + }, +' _ props _ ' }, + ] + }, + "_links" : { + "curies" : { + "href" : "http://purl.org/sipwise/ngcp-api/#rel-{rel}", + "name" : "ngcp", + "templated" : true + }, + "next" : { + "href" : "/api/' _ id _ '/?page=2&rows=1" + }, + "ngcp:' _ id _ '" : [ + { + "href" : "/api/' _ id _ '/1" + }, + ], + "profile" : { + "href" : "http://purl.org/sipwise/ngcp-api/" + }, + "self" : { + "href" : "/api/' _ id _ '/?page=1&rows=1" + } + }, + "total_count" : 100 +}'; + + INCLUDE helpers/api_req_res.tt request=request response=response level=level+3; +-%] + + +
+
+[%
+ cmd = 'curl -i -X GET -H \'Connection: close\' --cert NGCP-API-client-certificate.pem --cacert ca-cert.pem \'https://example.org:1443/api/' _ id _ '/1\'';
+ INCLUDE helpers/api_command.tt cmd=cmd level=level+3;
+
+ props = ' "id" : 1';
+ FOREACH p IN col.fields;
+ NEXT IF p.types.0 == 'null';
+ props = props _ ',
+';
+ IF p.types.0 == "Number";
+ val = 4;
+ ELSIF p.types.0 == "String";
+ val = '"test"';
+ ELSIF p.types.0 == "Boolean";
+ val = 'true';
+ ELSIF p.types.0 == "Array";
+ val = '[]';
+ ELSE;
+ val = '"missing"';
+ END;
+ props = props _ ' "' _ p.name _ '" : ' _ val;
+ END;
+ props = props _ '
+';
+ request =
+'GET /api/' _ id _ '/1 HTTP/1.1';
+ response =
+'HTTP/1.1 200 OK
+Content-Type: application/hal+json; profile="http://purl.org/sipwise/ngcp-api/"
+Link: ; rel=collection
+Link:
+[% + props = ''; + FOREACH p IN col.fields; + NEXT IF p.types.0 == 'null'; + IF p.types.0 == "Number"; + val = 4; + ELSIF p.types.0 == "String"; + val = '"test"'; + ELSIF p.types.0 == "Boolean"; + val = 'true'; + ELSIF p.types.0 == "Array"; + val = '[]'; + ELSE; + val = '"missing"'; + END; + props = props _ '"' _ p.name _ '" : ' _ val; + props = props _ ', '; + END; + props = props.substr(0, props.length - 2); + + cmd = 'curl -i -X POST -H \'Connection: close\' -H \'Content-Type: application/json\' --cert NGCP-API-client-certificate.pem --cacert ca-cert.pem \'https://example.org:1443/api/' _ id _ '/\' --data-binary \'{ ' _ props _ ' }\''; + INCLUDE helpers/api_command.tt cmd=cmd level=level+3; + + props = ''; + FOREACH p IN col.fields; + NEXT IF p.types.0 == 'null'; + IF p.types.0 == "Number"; + val = 4; + ELSIF p.types.0 == "String"; + val = '"test"'; + ELSIF p.types.0 == "Boolean"; + val = 'true'; + ELSIF p.types.0 == "Array"; + val = '[]'; + ELSE; + val = '"missing"'; + END; + props = props _ ' "' _ p.name _ '" : ' _ val; + props = props _ ', +'; + END; + props = props.substr(0, props.length - 2); + request = +'POST /api/' _ id _ '/ HTTP/1.1 +Content-Type: application/json + +{ +' _ props _ ' +}'; + response = +'HTTP/1.1 201 Created +Location: /api/' _ id _ '/2'; + + INCLUDE helpers/api_req_res.tt request=request response=response level=level+3; +%] +
+ ++[% + props = ''; + FOREACH p IN col.fields; + NEXT IF p.types.0 == 'null'; + IF p.types.0 == "Number"; + val = 4; + ELSIF p.types.0 == "String"; + val = '"test"'; + ELSIF p.types.0 == "Boolean"; + val = 'true'; + ELSIF p.types.0 == "Array"; + val = '[]'; + ELSE; + val = '"missing"'; + END; + props = props _ '"' _ p.name _ '" : ' _ val; + props = props _ ', '; + END; + props = props.substr(0, props.length - 2); + + cmd = 'curl -i -X PUT -H \'Connection: close\' -H \'Content-Type: application/json\' -H \'Prefer: return=minimal\' --cert NGCP-API-client-certificate.pem --cacert ca-cert.pem \'https://example.org:1443/api/' _ id _ '/2\' --data-binary \'{ ' _ props _ ' }\''; + INCLUDE helpers/api_command.tt cmd=cmd extended=1 level=level+3; + + props = ''; + FOREACH p IN col.fields; + NEXT IF p.types.0 == 'null'; + IF p.types.0 == "Number"; + val = 4; + ELSIF p.types.0 == "String"; + val = '"test"'; + ELSIF p.types.0 == "Boolean"; + val = 'true'; + ELSIF p.types.0 == "Array"; + val = '[]'; + ELSE; + val = '"missing"'; + END; + props = props _ ' "' _ p.name _ '" : ' _ val; + props = props _ ', +'; + END; + props = props.substr(0, props.length - 2); + request = +'PUT /api/' _ id _ '/2 HTTP/1.1 +Content-Type: application/json +Prefer: return=minimal + +{ +' _ props _ ' +}'; + response = +'HTTP/1.1 204 No Content +Preference-Applied: return=minimal'; + + INCLUDE helpers/api_req_res.tt request=request response=response level=level+3; +-%] +
+ ++[% + props = ''; rem = 0; rep = 0; + FOREACH p IN col.fields; + type = p.types.0; + IF type == 'null'; + NEXT IF rem >= 1; + op = "remove"; + type = p.types.1; + rem = rem + 1; + ELSE; + NEXT IF rep >= 1; + op = "replace"; + rep = rep + 1; + END; + + IF type == "Number"; + val = 5; + ELSIF type == "String"; + val = '"other"'; + ELSIF type == "Boolean"; + val = 'false'; + ELSIF type == "Array"; + val = '[]'; + ELSE; + val = '"missing"'; + END; + props = props _ '{ '; + props = props _ '"op" : "' _ op _ '", "path" : "/' _ p.name _ '"'; + UNLESS op == "remove"; + props = props _ ', "value" : ' _ val; + END; + props = props _ ' }, '; + LAST IF rep >= 1 && rem >= 1; + END; + props = props.substr(0, props.length - 2); + + cmd = 'curl -i -X PATCH -H \'Connection: close\' -H \'Content-Type: application/json-patch+json\' -H \'Prefer: return=minimal\' --cert NGCP-API-client-certificate.pem --cacert ca-cert.pem \'https://example.org:1443/api/' _ id _ '/2\' --data-binary \'[ ' _ props _ ' ]\''; + INCLUDE helpers/api_command.tt cmd=cmd extended=1 level=level+3; +%] + +
+ The PATCH method allows to operate on specific fields of an item. The path attribute can point to a normal property (e.g. /something) or to a specific element in an array (e.g. /something/0). Available op values are: +
-
+
-
+ remove
+
Removes the property pointed to by path. You can point to a normal property (e.g. /something) or to a specific element in an array (e.g. /something/0).
+
+ -
+ replace
+
Replaces the value pointed to by path by the new value passed via value.
+
+ -
+ add
+
Adds a new property path by the new value passed via value.
+
+ -
+ copy, move
+
Copies or moves (copy, then remove) the value from property defined by from to the propery defined by path.
+
+
-The systemcontacts item is used to specify the contact information of peering and reseller contracts. -
- -None
- - --[% - cmd = 'curl -i -X OPTIONS -H \'Connection: close\' --cert NGCP-API-client-certificate.pem --cacert ca-cert.pem https://example.org:1443/api/systemcontacts/'; - INCLUDE helpers/api_command.tt cmd=cmd level=level+3; - - request = [ - 'OPTIONS /api/systemcontacts/ HTTP/1.1' - ]; - response = [ - 'HTTP/1.1 200 OK', - 'Allow: GET, HEAD, OPTIONS, POST', - 'Accept-Post: application/hal+json; profile="http://purl.org/sipwise/ngcp-api/#rel-systemcontacts"', - ]; - INCLUDE helpers/api_req_res.tt request=request response=response level=level+3; --%] -
- --
- You cannot request the entire collection at once, but instead you can simply page through the results. The response provides prev and next links you can follow to get the next page. - - To define the page number and the rows per page to return, you can pass the parameters page and rows. Default values are page=1 and rows=10, if you do not provide them. -
-[% - cmd = 'curl -i -X GET -H \'Connection: close\' --cert NGCP-API-client-certificate.pem --cacert ca-cert.pem \'https://example.org:1443/api/systemcontacts/?page=1&rows=2\''; - INCLUDE helpers/api_command.tt cmd=cmd level=level+3; - - request = [ - 'GET /api/systemcontacts/ HTTP/1.1', - ]; - response = [ -'HTTP/1.1 200 OK -Content-Type: application/hal+json; profile="http://purl.org/sipwise/ngcp-api/" -Link: ; rel="item http://purl.org/sipwise/ngcp-api/#rel-systemcontacts" -Link: ; rel="item http://purl.org/sipwise/ngcp-api/#rel-systemcontacts" -Link:
-[%
- cmd = 'curl -i -X GET -H \'Connection: close\' --cert NGCP-API-client-certificate.pem --cacert ca-cert.pem \'https://example.org:1443/api/systemcontacts/3\'';
- INCLUDE helpers/api_command.tt cmd=cmd level=level+3;
-
- request = [
- 'GET /api/systemcontacts/3 HTTP/1.1',
- ];
- response = [
-'HTTP/1.1 200 OK
-Content-Type: application/hal+json; profile="http://purl.org/sipwise/ngcp-api/"
-Link: ; rel=collection
-Link:
-[% - cmd = 'curl -i -X POST -H \'Connection: close\' --cert NGCP-API-client-certificate.pem --cacert ca-cert.pem \'https://example.com:1443/api/systemcontacts/\' --data-binary \'{ "firstname": "John", "lastname": "Doe", "city": null, "company": null, "country": null, "phonenumber": null, "postcode": null, "street": null, "email": "john.doe@reseller.invalid", "reseller_id": 1 }\' -H \'Content-Type: application/json\''; - INCLUDE helpers/api_command.tt cmd=cmd level=level+3; - - request = [ - 'POST /api/systemcontacts/ HTTP/1.1', - 'Content-Type: application/json', - '', -'{ - "firstname": "John", - "lastname": "Doe", - "email": "john.doe@reseller.invalid", - "city": null, - "company": null, - "country": null, - "phonenumber": null, - "postcode": null, - "street": null -}', - ]; - response = [ -'HTTP/1.1 201 Created -Location: /api/systemcontacts/280' - ]; - - INCLUDE helpers/api_req_res.tt request=request response=response level=level+3; --%] -
- --[% - cmd = 'curl -i -X PUT -H \'Connection: close\' --cert NGCP-API-client-certificate.pem --cacert ca-cert.pem \'https://example.org:1443/api/systemcontacts/10\' --data-binary \'{ "firstname": "John", "lastname": "Doe", "email": "something.else@reseller.invalid", "city": null, "company": null, "country": null, "phonenumber": null, "postcode": null, "street": null }\' -H \'Content-Type: application/json\' -H \'Prefer: return=minimal\''; - INCLUDE helpers/api_command.tt cmd=cmd extended=1 level=level+3; - - request = [ - 'PUT /api/contacts/10 HTTP/1.1', - 'Content-Type: application/json', - 'Prefer: return=minimal', - '', -'{ - "firstname": "John", - "lastname": "Doe", - "email": "something.else@reseller.invalid", - "city": null, - "company": null, - "country": null, - "phonenumber": null, - "postcode": null, - "street": null -}', - ]; - response = [ - 'HTTP/1.1 204 No Content', - 'Preference-Applied: return=minimal', - ]; - - INCLUDE helpers/api_req_res.tt request=request response=response level=level+3; --%] -
- --[% - cmd = 'curl -i -X PATCH -H \'Connection: close\' --cert NGCP-API-client-certificate.pem --cacert ca-cert.pem \'https://example.org:1443/api/systemcontacts/10 --data-binary \'[ { "op": "replace", "path": "/email", "value": "other.john.doe@reseller.invalid" }, { "op": "replace", "path": "/street", "value": "Some Street" } ]\' -H \'Content-Type: application/json-patch+json\' -H \'Prefer: return=minimal\''; - INCLUDE helpers/api_command.tt cmd=cmd extended=1 level=level+3; - - request = [ - 'PATCH /api/systemcontacts/10 HTTP/1.1', - 'Content-Type: application/json-patch+json', - 'Prefer: return=minimal', - '', -'[ - { - "op": "replace", - "path": "/email", - "value": "other.john.doe@reseller.invalid" - }, - { - "op": "replace", - "path": "/street", - "value": "Some Street" - } -]', - ]; - response = [ - 'HTTP/1.1 204 No Content', - 'Preference-Applied: return=minimal', - ]; - - INCLUDE helpers/api_req_res.tt request=request response=response level=level+3; --%] - -
- Note that for PATCH, the body must be a JSON Array, even if there is only one 'op' entry. -
- - - -- Note that you MUST to pass the following additional headers for this request: + Note that you MUST pass the following additional headers for this request:
- Prefer
-
This header tells the API which type of response it expects. The following values are possible: +
This header tells the API which type of response the client expects. The following values are possible:
- return=minimal tells the API to respond with a 204 No Content if the operation has been performed successfully, without returning the updated resource in the body.
- return=representation will let the API respond with 200 OK with the full representation of the updated resource in the body.