Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcCreated_at
LOCAL lcExpires_at
LOCAL lcInvite_type
LOCAL lcUuid
LOCAL lcId
LOCAL lcDataId
LOCAL lcV_Type
LOCAL lcDataType
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
loHttp.SetRequestHeader("Accept","application/json")
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://api.app.ddog-gov.com/api/v2/user_invitations/:user_invitation_uuid",loSbResponseBody)
IF (lnSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loSbResponseBody
CANCEL
ENDIF
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loHttp.LastHeader
? "Failed."
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
* Sample JSON response:
* (Sample code for parsing the JSON response is shown below)
* {
* "data": {
* "attributes": {
* "created_at": "<dateTime>",
* "expires_at": "<dateTime>",
* "invite_type": "<string>",
* "uuid": "<string>"
* },
* "id": "<string>",
* "relationships": {
* "user": {
* "data": {
* "id": "<string>",
* "type": "users"
* }
* }
* },
* "type": "user_invitations"
* }
* }
* Sample code for parsing the JSON response...
* Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
lcCreated_at = loJResp.StringOf("data.attributes.created_at")
lcExpires_at = loJResp.StringOf("data.attributes.expires_at")
lcInvite_type = loJResp.StringOf("data.attributes.invite_type")
lcUuid = loJResp.StringOf("data.attributes.uuid")
lcId = loJResp.StringOf("data.id")
lcDataId = loJResp.StringOf("data.relationships.user.data.id")
lcV_Type = loJResp.StringOf("data.relationships.user.data.type")
lcDataType = loJResp.StringOf("data.type")
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
Curl Command
curl -X GET
-H "Accept: application/json"
https://api.app.ddog-gov.com/api/v2/user_invitations/:user_invitation_uuid
Postman Collection Item JSON
{
"name": "Get a user invitation",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/user_invitations/:user_invitation_uuid",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"user_invitations",
":user_invitation_uuid"
],
"variable": [
{
"key": "user_invitation_uuid",
"value": "<string>"
}
]
},
"description": "Returns a single user invitation by its UUID."
},
"response": [
{
"name": "OK",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/user_invitations/:user_invitation_uuid",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"user_invitations",
":user_invitation_uuid"
],
"variable": [
{
"key": "user_invitation_uuid"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"data\": {\n \"attributes\": {\n \"created_at\": \"<dateTime>\",\n \"expires_at\": \"<dateTime>\",\n \"invite_type\": \"<string>\",\n \"uuid\": \"<string>\"\n },\n \"id\": \"<string>\",\n \"relationships\": {\n \"user\": {\n \"data\": {\n \"id\": \"<string>\",\n \"type\": \"users\"\n }\n }\n },\n \"type\": \"user_invitations\"\n }\n}"
},
{
"name": "Authentication error",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/user_invitations/:user_invitation_uuid",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"user_invitations",
":user_invitation_uuid"
],
"variable": [
{
"key": "user_invitation_uuid"
}
]
}
},
"status": "Forbidden",
"code": 403,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
},
{
"name": "Not found",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/user_invitations/:user_invitation_uuid",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"user_invitations",
":user_invitation_uuid"
],
"variable": [
{
"key": "user_invitation_uuid"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
},
{
"name": "Too many requests",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"description": "Added as a part of security scheme: apikey",
"key": "DD-API-KEY",
"value": "<API Key>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/user_invitations/:user_invitation_uuid",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"user_invitations",
":user_invitation_uuid"
],
"variable": [
{
"key": "user_invitation_uuid"
}
]
}
},
"status": "Too Many Requests",
"code": 429,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n \"<string>\",\n \"<string>\"\n ]\n}"
}
]
}
