This is a set of APIs and examples pointing to the development version of APIs in OpenDKP. This folder (OpenDKP) has Authorization settings created using oAuth 2.0.
\nOpenDKP APIs where authorization is needed requries an oAuth 2.0 ID Token. This Postman collection contains the needed configuration to retrieve an access token. Click on the Authorization Tab of the folder \"OpenDKP\" and you'll be able to click on Get New Access Token at the bottom.
\nAlternatively, if you'll be creating scripts/code to interact with OpenDKP APIs, please follow the oAuth 2.0 folder pattern to retrieve Access Tokens, ID Tokens and Refresh Tokens.
\nNOTE: Authorization header is expected to be an ID Token, NOT Access Token.
\nWhere you see {{host}} in URLs, that is referencing the production or development version of the APIs. Regardless of which environment you are pointing to, please note that the same database sits behind both dev and prod.
\nValid Hosts:
\napi-test.opendkp.com development environment where the latest changes are done on the API and tested
\napi.opendkp.com production environment where the UI/Experiencel layer interacts with
\nWhere you see {{client}} in the URLs, that is referencing the subdomain of your opendkp site. For example, if your website is ogc.opendkp.com then your client is simply ogc. A completed URL might look like this:
\nhost.com/dev/clients/ogc/adjustments
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"29026956","collectionId":"d66acc1b-90db-4884-a9ff-258c46941b15","publishedId":"2sA2xh2CT1","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-03-08T18:40:25.000Z"},"item":[{"name":"Clients","item":[{"name":"Get Client","id":"9557cf00-3877-41a6-a173-ab73c57d6faa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://{{host}}/clients/{{client}}","description":"This request will fetch the client details of a particular client. This request is likely not useful for external api development uses.
\n","urlObject":{"protocol":"https","path":["clients","{{client}}"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"9557cf00-3877-41a6-a173-ab73c57d6faa"},{"name":"Get Client Status","id":"49932c75-6114-40ff-b668-a66dfeb9a862","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://{{host}}/clients/{{client}}/status","description":"This request gets the client status. The status determines whether dkp data will be displayed to the UI as well as showing the Subscription Status to the Admin UI screen. This request is likely not useful for external api development uses.
\n","urlObject":{"protocol":"https","path":["clients","{{client}}","status"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"49932c75-6114-40ff-b668-a66dfeb9a862"},{"name":"Cancel Subscription","id":"98db446a-5b10-43b8-b2bd-76763293992b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://{{host}}/clients/{{client}}/status","description":"This request will cancel the current paypal subscription tied to the specified OpenDKP client. Your Access Token must have you listed as part of the DKP Admin Group associated with the client you are attempting to cancel the subscription for. This request is likely not useful for external api development uses.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"d66acc1b-90db-4884-a9ff-258c46941b15","id":"d66acc1b-90db-4884-a9ff-258c46941b15","name":"OpenDKP","type":"collection"}},"urlObject":{"protocol":"https","path":["clients","{{client}}","status"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"98db446a-5b10-43b8-b2bd-76763293992b"},{"name":"Update Subscription","id":"8def4519-4be0-4a9b-82e4-2ab1466d8346","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"subscriptionId\": \"I-TestSubscriptionId\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{host}}/clients/{{client}}/status","description":"This HTTP POST request is used to update the status of a client's subscription. The request should be sent to https://{{host}}/clients/{{client}}/status. The request body should be in raw format and should contain a JSON object with the \"subscriptionId\" field.
\nThe response to this request will have a status code of 500 and a content type of application/json. The response body will be a JSON object containing \"ErrorMessage\" and \"StatusCode\" fields.
\nThis endpoint makes an HTTP GET request to retrieve a list of clients. The response will be in JSON format with an array of client objects, each containing the \"Subdomain\", \"Name\", and \"ClientId\" properties.
\n","urlObject":{"protocol":"https","path":["clients"],"host":["api-test","opendkp","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"8c594bd5-8736-4f93-a2c4-16cb0d8830a0"}],"id":"a7bc98c2-2aeb-417d-bd38-21614718c0ba","description":"This folder contains a collection of APIs related to the client.
\nA client is also known as the subdomain of your guild. For example, if your OpenDKP url is:
demo.opendkp.com
Then your client is 'demo'.
This folder holds high level client information, including the ability to get the client details, status, cancel subscription or update subscription.
\n","event":[{"listen":"prerequest","script":{"id":"5bbc3bd3-1723-4fbd-906d-3c46581763de","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f6556959-121c-4fd3-9fec-dfb1b103546d","type":"text/javascript","exec":[""]}}],"_postman_id":"a7bc98c2-2aeb-417d-bd38-21614718c0ba","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"d66acc1b-90db-4884-a9ff-258c46941b15","id":"d66acc1b-90db-4884-a9ff-258c46941b15","name":"OpenDKP","type":"collection"}}},{"name":"Adjustments","item":[{"name":"Get All Adjustments","id":"ea9a48f8-e559-4c5e-baa6-f62523f6c9af","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://{{host}}/clients/{{client}}/adjustments","description":"This endpoint retrieves the adjustments for a specific client. It makes an HTTP GET request to the specified URL with the client and environment parameters. The response will be in JSON format and will contain an array of adjustment objects, each including character details, name, description, value, timestamp, and ID.
\n","urlObject":{"protocol":"https","path":["clients","{{client}}","adjustments"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ea9a48f8-e559-4c5e-baa6-f62523f6c9af"},{"name":"Create Adjustment","id":"4afdceaf-aa81-4418-9f24-ebad6a142cd1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"Name\": \"New API\",\r\n \"Description\": \"New API\",\r\n \"Value\": 25,\r\n \"Character\": {\r\n \"Name\": \"Moncs\"\r\n },\r\n \"Timestamp\": \"2024-03-02T21:28:07.901Z\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{host}}/clients/{{client}}/adjustments","description":"This endpoint is used to update adjustments for a specific client.
\nPUT
\nhttps://{{host}}/clients/{{client}}/adjustments
\n200
\napplication/json
\nThe response will contain an array of adjusted client details with the following properties:
\nThis HTTP POST request is used to add adjustments for a specific client. The request should be sent to https://{{host}}/clients/{{client}}/adjustments.
\nThe request body should be in raw format and include the following parameters:
\nThe response to the request will have a status code of 200 and a content type of application/json. The response will include the following parameters:
\nThis endpoint retrieves the details of a specific adjustment for a client. It makes an HTTP GET request to the specified URL with the client and adjustment ID in the path parameters. The response will be in JSON format and will include details such as the character, name, description, value, timestamp, and ID of the adjustment.
\n","urlObject":{"protocol":"https","path":["clients","{{client}}","adjustments","1"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4c2465ce-5d88-42f0-bb74-5c4df5c352b8"},{"name":"Delete Adjustment","id":"220053ce-05ba-4a0b-aa8c-2a71ee735dd7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://{{host}}/clients/{{client}}/adjustments/2","description":"This endpoint sends an HTTP DELETE request to remove an adjustment with the specified ID for a client. The request should be made to https://{{host}}/clients/{{client}}/adjustments/2.
\nThe response to the last execution had a status code of 200 and a content type of application/json. The response body included a message and status code.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"d66acc1b-90db-4884-a9ff-258c46941b15","id":"d66acc1b-90db-4884-a9ff-258c46941b15","name":"OpenDKP","type":"collection"}},"urlObject":{"protocol":"https","path":["clients","{{client}}","adjustments","2"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"220053ce-05ba-4a0b-aa8c-2a71ee735dd7"}],"id":"4e9e9ce2-d3d1-43cc-895f-07778aaa13a4","_postman_id":"4e9e9ce2-d3d1-43cc-895f-07778aaa13a4","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"d66acc1b-90db-4884-a9ff-258c46941b15","id":"d66acc1b-90db-4884-a9ff-258c46941b15","name":"OpenDKP","type":"collection"}}},{"name":"Characters","item":[{"name":"Links","item":[{"name":"Get Linked Characters","id":"e27e4565-c465-42dd-8e9a-4c15854539b2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://{{host}}/clients/{{client}}/characters/links/1","description":"This API endpoint retrieves the links for characters associated with a specific client. It makes an HTTP GET request to the provided URL with the environment and client parameters. The response will include LinkedCharacters and AvailableCharacters data for the specified client.
\nThe response will have a status code of 200 and a content type of application/json. The response body will contain an array of LinkedCharacters, each with ParentId, ChildId, ParentName, ChildName, ParentRank, ChildRank, ParentClass, ChildClass, Id, and ClientId fields. Additionally, the response will include an array of AvailableCharacters, each with Id, AssociatedId, Active, Name, Rank, Class, Level, MainChange, Deleted, and CreatedDate fields.
\n","urlObject":{"protocol":"https","path":["clients","{{client}}","characters","links","1"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e27e4565-c465-42dd-8e9a-4c15854539b2"},{"name":"Delete Link","id":"6c652d4f-32ed-4974-b17b-cff0e634de6c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://{{host}}/clients/{{client}}/characters/links/1030","description":"This endpoint sends an HTTP DELETE request to remove a character link associated with a specific client. The request should be made to the URL https://{{host}}/clients/{{client}}/characters/links/1030.
\nUpon a successful deletion, the server responds with a status code of 200 and a JSON object in the response body. The response object includes a \"Message\" field and a \"StatusCode\" field, which indicates the outcome of the operation.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"d66acc1b-90db-4884-a9ff-258c46941b15","id":"d66acc1b-90db-4884-a9ff-258c46941b15","name":"OpenDKP","type":"collection"}},"urlObject":{"protocol":"https","path":["clients","{{client}}","characters","links","1030"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6c652d4f-32ed-4974-b17b-cff0e634de6c"},{"name":"Insert Link","id":"34844377-de61-4392-8313-52289f1c9770","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"ParentId\": \"1\",\r\n \"ChildId\": 79\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{host}}/clients/{{client}}/characters/links","description":"This endpoint makes an HTTP PUT request to update the links between client characters. The request should be sent to https://{{host}}/clients/{{client}}/characters/links.
\nThe request body should be in raw format and include the following parameters:
\nParentId: (string) The ID of the parent character.ChildId: (number) The ID of the child character.This endpoint retrieves adjustments for a specific character belonging to a client.
\nThe request should be sent as an HTTP GET to the provided URL, with the 'environment' and 'client' path parameters filled in. The '1' in the path represents the character ID for which adjustments are being retrieved.
\nThe response will have a status code of 200 and a content type of application/json. The body of the response will contain an array of objects, each representing an adjustment with properties including Id, Name, Description, Value, Timestamp, and CharacterId.
\n","urlObject":{"protocol":"https","path":["clients","{{client}}","characters","1","adjustments"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"521ffa72-9392-4459-84db-c9bd15c31ad9"},{"name":"Get All Characters","id":"7ff547fa-90a7-47b2-97b2-d4d640a9d5bb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://{{host}}/clients/{{client}}/characters?IncludeInactives=true","description":"This endpoint makes an HTTP GET request to retrieve the characters associated with a specific client. The request includes the client ID and an option to include inactive characters. The response will be in JSON format and will include an array of character objects with various attributes such as ID, name, rank, class, level, race, gender, guild, and other details.
\nThe last execution of this request returned a 200 status code, indicating a successful response. The response body included an array of character objects, each containing attributes like ClientId, Id, AssociatedId, Active, Name, Rank, Class, Level, Race, Gender, Guild, MainChange, Deleted, User, and CreatedDate.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"d66acc1b-90db-4884-a9ff-258c46941b15","id":"d66acc1b-90db-4884-a9ff-258c46941b15","name":"OpenDKP","type":"collection"}},"urlObject":{"protocol":"https","path":["clients","{{client}}","characters"],"host":["{{host}}"],"query":[{"description":{"content":"Determines whether inactive characters are displayed, the default is false if the query parameter is not present in the request
\n","type":"text/plain"},"key":"IncludeInactives","value":"true"}],"variable":[]}},"response":[],"_postman_id":"7ff547fa-90a7-47b2-97b2-d4d640a9d5bb"},{"name":"Get Character Decay Models","id":"e53e1a5f-6ac1-4ad4-b336-b93e85062a36","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://{{host}}/clients/{{client}}/characters/1/decay","description":"This endpoint retrieves the decay details for a specific character belonging to a client. The HTTP GET request should be made to the following URL: https://{{host}}/clients/{{client}}/characters/1/decay.
The response will have a status code of 200 and a content type of application/json. The response body will contain an array of objects, each representing the decay details for the character. Each object will include properties such as StartDate, EndDate, EffectiveDate, StartingDKP, DkpEarned, Items, Adjustments, ValueToDecay, DecayAmount, DecayRate, TotalDecayed, and TotalDkp.
This endpoint retrieves information about a specific character for a client.
\nhttps://{{host}}/clients/{{client}}/characters/1\n\n{{environment}} (path parameter): The environment for the request.{{client}} (path parameter): The client ID.{\n \"ClientId\": \"\",\n \"Id\": 0,\n \"AssociatedId\": 0,\n \"Active\": 0,\n \"Name\": \"\",\n \"Rank\": \"\",\n \"Class\": \"\",\n \"Level\": 0,\n \"Race\": \"\",\n \"Gender\": \"\",\n \"Guild\": \"\",\n \"MainChange\": \"\",\n \"Deleted\": 0,\n \"User\": \"\",\n \"CreatedDate\": \"\"\n}\n\nThis endpoint retrieves the items associated with a specific character for a particular client.
\nGET https://{{host}}/clients/{{client}}/characters/1/items
Upon a successful execution, the server responds with a status code of 200 and a JSON array containing the items. Each item object includes the following properties:
\nItemName (string): The name of the item.ItemID (integer): The ID of the item.GameItemId (integer): The ID of the item in the game.RaidID (integer): The ID of the raid associated with the item.Raid (string): The name of the raid associated with the item.Date (string): The date of the item.DkpValue (integer): The DKP (Dragon Kill Points) value of the item.Notes (string): Any additional notes related to the item.This API endpoint retrieves a list of deleted characters for a specific client.
\nhttps://{{host}}/clients/{{client}}/characters/deletedThe API returns a JSON array with the following fields for each deleted character:
\nClientId (string): The client IDId (integer): The character IDAssociatedId (integer): The associated IDActive (integer): The activity statusName (string): The character's nameRank (string): The character's rankClass (string): The character's classLevel (integer): The character's levelRace (string): The character's raceGender (string): The character's genderGuild (string): The character's guildMainChange (string): The main changeDeleted (integer): The deletion statusUser (string): The user associated with the characterCreatedDate (string): The date of creationThis endpoint makes an HTTP GET request to retrieve information about raids for a specific character within a given lookback period. The URL includes path parameters for the environment, client, and character ID, along with a query parameter for the lookback period in days.
\nenvironment (path parameter): The environment for the request.client (path parameter): The client for whom the character information is being fetched.lookback (query parameter): The number of days to look back for raid information.The response will have a status code of 200, indicating a successful request. The content type of the response is application/json, and it will contain an array of objects with information about raids. Each object includes details such as the raid name, pool name, raid ID, timestamp, and an array of ticks with their respective IDs and attendance status.
Number of days to look back for raids
\n","type":"text/plain"},"key":"lookback","value":"60"}],"variable":[]}},"response":[],"_postman_id":"50cb06f1-022f-4a19-8375-7a3e2ea7f9fe"},{"name":"Get Characters by Account","id":"ce969515-bea8-425e-a7d8-8d2da76372ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://{{host}}/clients/{{client}}/accounts/Admin/characters","description":"This endpoint makes an HTTP GET request to retrieve the characters associated with the specified client's account. It fetches the characters' details such as ID, name, rank, class, level, race, gender, guild, main change, and creation date.
\nThe response to the last execution had a status code of 200 and a content type of application/json. The response body included an array of objects, each representing a character with attributes like ClientId, Id, AssociatedId, Active, Name, Rank, Class, Level, Race, Gender, Guild, MainChange, Deleted, and CreatedDate.
\n","urlObject":{"protocol":"https","path":["clients","{{client}}","accounts","Admin","characters"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ce969515-bea8-425e-a7d8-8d2da76372ec"},{"name":"Insert Character","event":[{"listen":"test","script":{"id":"cbe27476-1739-41fe-a717-07cb435d9f3b","exec":["// Stores the StatusCode in an environment or global variable\r","var statusCode = pm.response.json().StatusCode;\r","pm.environment.set(\"statusCode\", statusCode);"],"type":"text/javascript"}}],"id":"7fec9f19-7459-41b7-b33c-838d11d9511d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"Active\": 1,\r\n \"Name\": \"TestA\",\r\n \"Rank\": \"Leader\",\r\n \"Class\": \"Bard\",\r\n \"Level\": 50,\r\n \"Race\": \"Dark Elf\",\r\n \"Gender\": \"Male\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{host}}/clients/{{client}}/characters","description":"This endpoint allows you to update the characters associated with a specific client. The HTTP PUT request should be made to https://{{host}}/clients/{{client}}/characters.
\nThe request should include a raw JSON payload with the following parameters:
\nIn case of a successful execution, the endpoint returns a status code of 500 and a JSON response with the following parameters:
\n{\n \"Active\": 0,\n \"Name\": \"\",\n \"Rank\": \"\",\n \"Class\": \"\",\n \"Level\": 0,\n \"Race\": \"\",\n \"Gender\": \"\"\n}\n{\n \"ErrorMessage\": \"\",\n \"StatusCode\": 0\n}\nThis endpoint is used to delete a specific character associated with a client.
\nMethod: DELETE
\nURL: https://{{host}}/clients/{{client}}/characters/99249
Status: 200
\nContent-Type: application/json
\n{ \"Message\":\"\", \"StatusCode\":0 }
\nUnclaims the character for the specified character id
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"d66acc1b-90db-4884-a9ff-258c46941b15","id":"d66acc1b-90db-4884-a9ff-258c46941b15","name":"OpenDKP","type":"collection"}},"urlObject":{"protocol":"https","path":["clients","{{client}}","accounts","Admin","characters","45"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"1edf1133-317e-4267-a3d8-fa1cb4bd1c27"},{"name":"Update Character by Id","id":"24890eec-0522-42e6-b75c-f9999b245abb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"AssociatedId\": -1,\r\n \"Active\": 1,\r\n \"Name\": \"Moncs\",\r\n \"Rank\": \"Main\",\r\n \"Class\": \"Monk\",\r\n \"Level\": 60,\r\n \"Race\": \"Dark Elf\",\r\n \"Gender\": \"Male\",\r\n \"Guild\": \"\",\r\n \"MainChange\": \"0001-01-01T00:00:00\",\r\n \"Deleted\": 0\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{host}}/clients/{{client}}/characters/1","description":"This endpoint allows you to add a new character for a specific client.
\nRequest Body
\nAssociatedId (number): The associated ID for the character.Active (number): The activity status of the character.Name (string): The name of the character.Rank (string): The rank of the character.Class (string): The class of the character.Level (number): The level of the character.Race (string): The race of the character.Gender (string): The gender of the character.Guild (string): The guild of the character.MainChange (string): The main change of the character.Deleted (number): The deletion status of the character.Id (number): The ID of the added character.AssociatedId (number): The associated ID of the character.Active (number): The activity status of the character.Name (string): The name of the character.Rank (string): The rank of the character.Class (string): The class of the character.Level (number): The level of the character.Race (string): The race of the character.Gender (string): The gender of the character.Guild (string): The guild of the character.MainChange (string): The main change of the character.Deleted (number): The deletion status of the character.CreatedDate (string): The date of creation for the character.Note: Replace {{environment}} and {{client}} with the appropriate values in the URL.
These APIs are all related to Characters
\n","_postman_id":"22a7a262-adf9-4be5-80b3-db391f709df1","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"d66acc1b-90db-4884-a9ff-258c46941b15","id":"d66acc1b-90db-4884-a9ff-258c46941b15","name":"OpenDKP","type":"collection"}}},{"name":"Settings","item":[{"name":"Get Setting","id":"2cf187c6-35a8-4129-9435-9abeecf93efd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://{{host}}/clients/{{client}}/settings/dkp_info","description":"This endpoint makes an HTTP GET request to retrieve the DKP (Dragon Kill Points) information settings for a specific client. The request should be made to the provided URL with the environment and client parameters in the path.
\nenvironment (path): The environment for the request.client (path): The specific client for which the DKP information settings are to be retrieved.Upon a successful request, the server returns a JSON object with the following fields:
\nClientId: The ID of the client.SettingName: The name of the DKP setting.SettingValue: The value of the DKP setting.UpdatedBy: The user who last updated the DKP setting.UpdatedTimestamp: The timestamp when the DKP setting was last updated.The response status for a successful request is 200, and the content type is application/json.
This endpoint allows the user to add settings for a specific client.
\nClientId (string): The unique identifier of the client.SettingName (string): The name of the setting to be added.SettingValue (string): The value of the setting.UpdatedBy (string): The user who updated the setting.UpdatedTimestamp (string): The timestamp when the setting was updated.Upon a successful request, the server responds with a status code of 200 and a JSON object containing the details of the added client setting, including the ClientId, SettingName, SettingValue, UpdatedBy, and UpdatedTimestamp.
Settings APIs are related to settings such as decay settings, security settings, dkp information, etc
\n","_postman_id":"5f274f07-bc6c-46d7-9407-124da636629a","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"d66acc1b-90db-4884-a9ff-258c46941b15","id":"d66acc1b-90db-4884-a9ff-258c46941b15","name":"OpenDKP","type":"collection"}}},{"name":"Utilities","item":[{"name":"Update Guild Details","id":"00dbca88-5247-469d-9686-ce62a54236d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Website\": \"http://opendkp.com\",\r\n \"Forums\": \"https://discord.gg/OneWingedAngels\",\r\n \"GuildName\": \"newapitest\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{host}}/clients/{{client}}/utilities/update-guild-details","description":"This endpoint allows you to update the details of a specific guild for a client.
\nWebsite (string, optional): The website of the guild.Forums (string, optional): The forums link of the guild.GuildName (string, optional): The name of the guild.Upon a successful update, the response will have a status code of 200 and a JSON object with the following properties:
\nMessage (string): A message indicating the result of the update.StatusCode (integer): A code indicating the status of the update operation.This HTTP POST request is used to update the logo for a specific client's utilities. The request should be made to https://{{host}}/clients/{{client}}/utilities/update-logo.
\nThe request should contain a raw body with the following parameters:
\nThe response to the request will have a status code of 200 and a content type of application/json. The response body will include the following parameters:
\nUtilities APIs are for changing the guild details, updating logo or updating a guild roster
\n","_postman_id":"27dbab6b-5a5f-4112-b28e-8ee6b7c51100","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"d66acc1b-90db-4884-a9ff-258c46941b15","id":"d66acc1b-90db-4884-a9ff-258c46941b15","name":"OpenDKP","type":"collection"}}},{"name":"Audits","item":[{"name":"Get All Audits","id":"e0788366-70e3-4bd6-b64a-b9bafb77bd16","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://{{host}}/clients/{{client}}/audits?page=1","description":"This endpoint retrieves a list of audits for a specific client. It makes an HTTP GET request to the specified URL with the client and environment parameters in the path, and the page number as a query parameter.
\nenvironment (path parameter): The environment for the request.client (path parameter): The client ID for which the audits are being retrieved.page (query parameter): The page number of the audits to be retrieved.Upon a successful request, the server responds with a status code of 200 and a JSON object containing an array of audits, along with the total number of pages and the current page.
\nThe response JSON structure:
\nAudits (array): An array of audit objects containing details such as client ID, audit ID, Cognito user, timestamp, and action.TotalPages (number): The total number of pages available for the audits.CurrentPage (number): The current page number of the retrieved audits.Please note that the actual values for the audit details will be populated in the response.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"d66acc1b-90db-4884-a9ff-258c46941b15","id":"d66acc1b-90db-4884-a9ff-258c46941b15","name":"OpenDKP","type":"collection"}},"urlObject":{"protocol":"https","path":["clients","{{client}}","audits"],"host":["{{host}}"],"query":[{"key":"page","value":"1"}],"variable":[]}},"response":[],"_postman_id":"e0788366-70e3-4bd6-b64a-b9bafb77bd16"},{"name":"GetAudit By Id","event":[{"listen":"test","script":{"id":"1be8d023-8b7c-4383-9cd9-63d3b3922284","exec":[""],"type":"text/javascript"}}],"id":"cf8f4b38-fddd-4bcc-908c-b0499072ee97","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://{{host}}/clients/{{client}}/audits/1621104","description":"This endpoint retrieves the audit details for a specific client. It makes an HTTP GET request to the specified URL with the client ID and audit ID in the path parameters. The response will have a status code of 200 and a JSON body containing the audit details, including the client ID, audit ID, Cognito user, timestamp, action, old value, and new value.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"d66acc1b-90db-4884-a9ff-258c46941b15","id":"d66acc1b-90db-4884-a9ff-258c46941b15","name":"OpenDKP","type":"collection"}},"urlObject":{"protocol":"https","path":["clients","{{client}}","audits","1621104"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"cf8f4b38-fddd-4bcc-908c-b0499072ee97"}],"id":"c5176fa9-05cf-45f5-b7e2-e845bf48d13b","description":"Audits APIs are used to get audit details
\n","_postman_id":"c5176fa9-05cf-45f5-b7e2-e845bf48d13b","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"d66acc1b-90db-4884-a9ff-258c46941b15","id":"d66acc1b-90db-4884-a9ff-258c46941b15","name":"OpenDKP","type":"collection"}}},{"name":"Accounts","item":[{"name":"Get All Accounts","id":"49a44288-4bf2-46d6-a40a-c93760feed8f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://{{host}}/clients/{{client}}/accounts","description":"This endpoint retrieves the accounts associated with a specific client. It makes an HTTP GET request to the specified URL with the client ID as a path parameter.
\nGET https://{{host}}/clients/{{client}}/accountsThe response to the request is a JSON object with the following structure:
\n{\n \"Admins\": [\n {\n \"Attributes\": [\n {\n \"Name\": \"\",\n \"Value\": \"\"\n }\n ],\n \"Enabled\": true,\n \"MFAOptions\": [],\n \"UserCreateDate\": \"\",\n \"UserLastModifiedDate\": \"\",\n \"Username\": \"\",\n \"UserStatus\": {\n \"Value\": \"\"\n }\n }\n ],\n \"AllUsers\": [\n {\n \"Attributes\": [\n {\n \"Name\": \"\",\n \"Value\": \"\"\n }\n ],\n \"Enabled\": true,\n \"MFAOptions\": [],\n \"UserCreateDate\": \"\",\n \"UserLastModifiedDate\": \"\",\n \"Username\": \"\",\n \"UserStatus\": {\n \"Value\": \"\"\n }\n }\n ],\n \"AssignedCharacters\": [\n {\n \"IdCharacter\": 0,\n \"Name\": \"\",\n \"User\": \"\",\n \"Rank\": \"\"\n }\n ]\n}\nThe response contains arrays of Admins, AllUsers, and AssignedCharacters, each with their respective attributes and values.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"d66acc1b-90db-4884-a9ff-258c46941b15","id":"d66acc1b-90db-4884-a9ff-258c46941b15","name":"OpenDKP","type":"collection"}},"urlObject":{"protocol":"https","path":["clients","{{client}}","accounts"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"49a44288-4bf2-46d6-a40a-c93760feed8f"},{"name":"Add Admin","id":"cd67cae7-e19a-41f4-b032-3c1753a4c291","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"Username\": \"Perdomo\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{host}}/clients/{{client}}/accounts/admins","description":"This HTTP PUT request is used to update the administrators' accounts for a specific client in the specified environment. The request should be made to the endpoint https://{{host}}/clients/{{client}}/accounts/admins.
\nThe request body should be in raw format and should include the \"Username\" parameter.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"d66acc1b-90db-4884-a9ff-258c46941b15","id":"d66acc1b-90db-4884-a9ff-258c46941b15","name":"OpenDKP","type":"collection"}},"urlObject":{"protocol":"https","path":["clients","{{client}}","accounts","admins"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"cd67cae7-e19a-41f4-b032-3c1753a4c291"},{"name":"Delete Admin","id":"e0b49b83-6677-4bed-b6ab-262a04b85449","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\r\n \"Username\": \"Perdomo\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{host}}/clients/{{client}}/accounts/admins","description":"This endpoint is used to delete the admin accounts associated with a specific client. The HTTP DELETE request should be sent to the specified URL with the client and environment parameters in the path. The request body should contain the username of the admin account to be deleted.
\nThis endpoint sends an HTTP DELETE request to remove the \"testuser\" account associated with a specific client. The request should be made to the provided URL with the appropriate environment and client parameters.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"d66acc1b-90db-4884-a9ff-258c46941b15","id":"d66acc1b-90db-4884-a9ff-258c46941b15","name":"OpenDKP","type":"collection"}},"urlObject":{"protocol":"https","path":["clients","{{client}}","accounts","testuser"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f1739dff-2f35-4a28-96c8-45a6d6563342"}],"id":"c8f55446-d3a7-4865-a660-a4dd25de1321","description":"Accounts APIs return account related information, thse are all authorized only apis
\n","_postman_id":"c8f55446-d3a7-4865-a660-a4dd25de1321","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"d66acc1b-90db-4884-a9ff-258c46941b15","id":"d66acc1b-90db-4884-a9ff-258c46941b15","name":"OpenDKP","type":"collection"}}},{"name":"DKP","item":[{"name":"Get DKP Summary","id":"2680d203-cc98-4c44-aa15-86e0002dd2e5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://{{host}}/clients/{{client}}/dkp","description":"This HTTP GET request retrieves the DKP (Dragon Kill Points) data for a specific client from the server. The request should be made to the endpoint https://{{host}}/clients/{{client}}/dkp. The response will be in JSON format with a status code of 200. The response body will contain an array of \"Models\" with details about the client's DKP, including current DKP, character information, attended ticks, total ticks, and calculated values for different time periods (30, 60, 90 days, and lifetime). The \"AsOfDate\" field indicates the date of the data.
\n","urlObject":{"protocol":"https","path":["clients","{{client}}","dkp"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"2680d203-cc98-4c44-aa15-86e0002dd2e5"},{"name":"Get DKP Details for Character","id":"cef0545d-ebbf-4124-9dd0-42395c03caa2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://{{host}}/clients/{{client}}/characters/1/dkp","description":"This endpoint retrieves the DKP (Dragon Kill Points) for a specific character belonging to a client. The request should be made using an HTTP GET method to the specified URL with the environment and client parameters in the path.
\nThe response will have a status code of 200 and a content type of application/json. The response body will contain an array of objects, each representing a DKP entry for the character. Each object includes properties such as Order, Date, SourceType, Source, SourceId, CharacterName, CharacterId, Value, Cumulative, and TickId.
\n","urlObject":{"protocol":"https","path":["clients","{{client}}","characters","1","dkp"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"cef0545d-ebbf-4124-9dd0-42395c03caa2"}],"id":"98ae80b7-f5a0-4364-834b-542560982527","description":"DKP APIs is used to fetch DKP information
\n","_postman_id":"98ae80b7-f5a0-4364-834b-542560982527","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"d66acc1b-90db-4884-a9ff-258c46941b15","id":"d66acc1b-90db-4884-a9ff-258c46941b15","name":"OpenDKP","type":"collection"}}},{"name":"Items","item":[{"name":"Get All Items","id":"c0f26581-0314-4723-823b-98672c5ac5ae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://{{host}}/items?first=0&total=250&filter=delete","description":"This endpoint makes an HTTP GET request to retrieve a list of items. The request includes query parameters for pagination and filtering. The \"first\" parameter is used to specify the starting index of the items, the \"total\" parameter is used to specify the total number of items to retrieve, and the \"filter\" parameter is used to apply a filter on the items.
\nfirst (number): Specifies the starting index of the items.total (number): Specifies the total number of items to retrieve.filter (string): Specifies the filter to be applied on the items.The response to the request has a status code of 200 and a content type of \"application/json\". The body of the response contains an array of \"Items\", where each item has \"IdItem\", \"Name\", \"GameItemId\", and \"IdGame\" properties. Additionally, the response includes the \"TotalRecords\" property indicating the total number of records.
\n","urlObject":{"protocol":"https","path":["items"],"host":["{{host}}"],"query":[{"key":"first","value":"0"},{"key":"total","value":"250"},{"key":"filter","value":"delete"}],"variable":[]}},"response":[],"_postman_id":"c0f26581-0314-4723-823b-98672c5ac5ae"},{"name":"Get All Client Items","id":"93b0bc48-ffa6-4a59-843e-a3c667a012ff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://{{host}}/clients/{{client}}/items?page=1","description":"This endpoint retrieves a list of items associated with a specific client, based on the provided page number.
\nGET https://{{host}}/clients/{{client}}/items?page=1
page (integer, required): Specifies the page number for paginated results.Upon a successful request, the server returns a JSON object with the following properties:
\nTotalPages (integer): Total number of pages available.
CurrentPage (integer): The current page number.
Models (array): An array of objects containing item details, including:
ItemName (string): The name of the item.
ItemId (integer): The unique identifier for the item.
CharacterName (string): The name of the character associated with the item.
DKP (integer): The DKP (Dragon Kill Points) value for the item.
RaidId (integer): The unique identifier for the associated raid.
\nCharacterId (integer): The unique identifier for the associated character.
\nTimestamp (string): The timestamp of the item entry.
Raid (string): The name of the raid associated with the item.
GameItemId (integer): The unique identifier for the associated game item.
Notes (string): Additional notes for the item.
{\n \"TotalPages\": 0,\n \"CurrentPage\": 0,\n \"Models\": [\n {\n \"ItemName\": \"\",\n \"ItemID\": 0,\n \"CharacterName\": \"\",\n \"DKP\": 0,\n \"IdRaid\": 0,\n \"IdCharacter\": 0,\n \"Timestamp\": \"\",\n \"Raid\": \"\",\n \"GameItemId\": 0,\n \"Notes\": \"\"\n }\n ]\n}\n\nThis endpoint makes an HTTP GET request to retrieve autocomplete suggestions for items based on the provided search query. The request should include the 'item' parameter for the search query, 'limit' parameter to specify the maximum number of suggestions, and 'game' parameter to filter items based on the game.
\nitem: (string) The search query for item suggestions.limit: (integer) The maximum number of suggestions to be returned.game: (integer) Filter parameter to specify the game for which the suggestions are required.Upon a successful execution, the server responds with a status code of 200 and a JSON array containing objects with the following properties:
\nItemID: (integer) The unique identifier for the item.ItemName: (string) The name of the item.GameItemId: (integer) The unique identifier for the game item.This endpoint allows you to create items by making an HTTP POST request to the specified URL. The request should include a payload in the raw request body type.
\n[\n {\n \"ItemName\": \"\",\n \"ItemID\": 0,\n \"GameItemId\": 0\n }\n]\nThis endpoint makes an HTTP GET request to retrieve information about a specific item belonging to a client. The URL includes placeholders for environment and client, which need to be replaced with actual values. The item ID is also included in the URL.
\n","urlObject":{"protocol":"https","path":["clients","{{client}}","items","4516"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c199f385-ceea-4928-a5e0-7cd6267d0a5c"},{"name":"Add Item to Database","id":"c21fe2fd-2116-464c-9281-95abcaee0970","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"Name\": \"deletelater\",\r\n \"GameItemId\": -1\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{host}}/items/{{client}}","description":"This HTTP PUT request is used to update an item with the given payload to the specified endpoint. The request should have a raw request body type with a JSON payload containing the \"Name\" and \"GameItemId\" fields.
\nUpon a successful execution, the response will have a status code of 200 and a JSON content type. The response body will include the updated \"IdItem\", \"Name\", \"GameItemId\", and \"IdGame\" fields.
\nExample:
\n{\n \"IdItem\": 0,\n \"Name\": \"\",\n \"GameItemId\": 0,\n \"IdGame\": 0\n}\nTop level items, interacts with the OpenDKP item table. These are not client specific but global across all of OpenDKP.
\n","_postman_id":"1e955a7e-2302-4e66-a7f9-33fe1fc16d09","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"d66acc1b-90db-4884-a9ff-258c46941b15","id":"d66acc1b-90db-4884-a9ff-258c46941b15","name":"OpenDKP","type":"collection"}}},{"name":"Pools","item":[{"name":"Get All Pools","id":"6cf5049f-c313-4b1c-8af8-1f882b3a8b45","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://{{host}}/pools","description":"This endpoint makes an HTTP GET request to retrieve a list of pools from the specified environment. The response will be in JSON format and will include the IdPool, Name, Description, and Order of each pool.
\n","urlObject":{"protocol":"https","path":["pools"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6cf5049f-c313-4b1c-8af8-1f882b3a8b45"}],"id":"1165db28-b571-4ecd-8b27-550333f9d997","_postman_id":"1165db28-b571-4ecd-8b27-550333f9d997","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"d66acc1b-90db-4884-a9ff-258c46941b15","id":"d66acc1b-90db-4884-a9ff-258c46941b15","name":"OpenDKP","type":"collection"}}},{"name":"Raids","item":[{"name":"Get Raid by Id","id":"f00a519c-501f-41df-a1fc-7dfe61b5fd3d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://{{host}}/clients/{{client}}/raids/1","description":"This endpoint retrieves information about a specific raid for a client. It makes an HTTP GET request to the specified URL with the client and environment parameters in the path. The response returns details about the raid, including the client ID, raid ID, name, timestamp, attendance, pool information, items, and ticks associated with the raid.
\n{\n \"ClientId\": \"8c4a72641730b\",\n \"Id\": 1,\n \"Name\": \"Raid #1\",\n \"Timestamp\": \"2024-03-07T07:31:41\",\n \"Attendance\": 1,\n \"Pool\": {\n \"Name\": \"RoS\",\n \"Description\": \"Ring of Scale\",\n \"Id\": 26\n },\n \"Items\": [\n {\n \"CharacterId\": 14,\n \"CharacterName\": \"Heomap\",\n \"GameItemId\": 64039,\n \"ItemId\": 64039,\n \"ItemName\": \"Sebilisian Commander's Report, Top Half\",\n \"Dkp\": 159.0,\n \"Notes\": \"\"\n },\n {\n \"CharacterId\": 35,\n \"CharacterName\": \"Sclif\",\n \"GameItemId\": 24763,\n \"ItemId\": 24763,\n \"ItemName\": \"Ice Silk Bracelet\",\n \"Dkp\": 135.0,\n \"Notes\": \"\"\n }\n ],\n \"Ticks\": [\n {\n \"Id\": 1,\n \"Value\": 14.0,\n \"Description\": \"Hour #1\",\n \"Characters\": [\n {\n \"Name\": \"Xeon\",\n \"Id\": 52\n },\n {\n \"Name\": \"Droz\",\n \"Id\": 56\n }\n ]\n },\n {\n \"Id\": 2,\n \"Value\": 24.0,\n \"Description\": \"Hour #2\",\n \"Characters\": [\n {\n \"Name\": \"Sampsonite\",\n \"Id\": 3\n },\n {\n \"Name\": \"Szandor\",\n \"Id\": 87\n }\n ]\n }\n ]\n}\n\nThis HTTP GET request retrieves a list of raids for a specific client from the server. The request URL includes placeholders for the environment and client, along with a query parameter 'count' to specify the number of raids to be returned., if count is less than 50, stats will be returned otherwise stats will be empty
\n","urlObject":{"protocol":"https","path":["clients","{{client}}","raids"],"host":["{{host}}"],"query":[{"description":{"content":"Optional query paramter. Determines the number of raids to return, ordered by the most recent raids first. if count is not present, will return all raids with no stats. If count is present, will include stats of returned raids. Count cannot be larger than 50, the server will take the minimum of count and 50.
\n","type":"text/plain"},"key":"count","value":"10"}],"variable":[]}},"response":[],"_postman_id":"1bae65ee-6a29-4cef-9e89-ae7503b088d1"},{"name":"Insert Raid","id":"d6836093-a15a-4586-bd13-44c2250ee885","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"Attendance\": 1,\r\n \"Items\": [\r\n {\r\n \"CharacterName\": \"Moncs\",\r\n \"Dkp\": 1,\r\n \"GameItemId\": 6639,\r\n \"ItemId\": 6639,\r\n \"ItemName\": \"Tranquil Staff\",\r\n \"Notes\": \"No Notes\"\r\n }\r\n ],\r\n \"Name\": \"MoncTest\",\r\n \"Pool\": {\r\n \"Description\": \"Planes of Power\",\r\n \"Name\": \"PoP\",\r\n \"Order\": 4,\r\n \"PoolId\": 6\r\n },\r\n \"Ticks\": [\r\n {\r\n \"Characters\": [\r\n {\r\n \"Name\": \"Moncs\"\r\n }\r\n ],\r\n \"Description\": \"TestTick1\",\r\n \"Value\": \"5\"\r\n }\r\n ],\r\n \"Timestamp\": \"2025-03-03T12:00:00.000Z\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{host}}/clients/{{client}}/raids","description":"This HTTP PUT request is used to update information about raids for a specific client in the system. The request should be made to the given URL with the specified path parameters for environment and client. The request body should be in raw format and include information about items, ticks, name, timestamp, pool, and attendance.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"d66acc1b-90db-4884-a9ff-258c46941b15","id":"d66acc1b-90db-4884-a9ff-258c46941b15","name":"OpenDKP","type":"collection"}},"urlObject":{"protocol":"https","path":["clients","{{client}}","raids"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d6836093-a15a-4586-bd13-44c2250ee885"},{"name":"Update Raid","id":"eb2f5f90-b235-42fa-a938-7e543932aabb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"ClientId\": \"8c4a72641730b\",\r\n \"RaidId\": 1,\r\n \"Name\": \"Raid #1\",\r\n \"Timestamp\": \"2024-03-13T07:31:46Z\",\r\n \"Attendance\": 1,\r\n \"Pool\": {\r\n \"Name\": \"RoF\",\r\n \"Description\": \"Rain of Fear\",\r\n \"PoolId\": 21\r\n },\r\n \"Items\": [\r\n {\r\n \"CharacterId\": 40,\r\n \"CharacterName\": \"Altcoin\",\r\n \"GameItemId\": 102419,\r\n \"ItemId\": 102419,\r\n \"ItemName\": \"Irae Faycite Shard: Freezing and Flashpyre\",\r\n \"Dkp\": 195,\r\n \"Notes\": \"\"\r\n },\r\n {\r\n \"CharacterId\": 42,\r\n \"CharacterName\": \"Danae\",\r\n \"GameItemId\": 82988,\r\n \"ItemId\": 82988,\r\n \"ItemName\": \"Sparkling Demantoid Stone\",\r\n \"Dkp\": 138,\r\n \"Notes\": \"\"\r\n },\r\n {\r\n \"CharacterId\": 21,\r\n \"CharacterName\": \"Dima\",\r\n \"GameItemId\": 84374,\r\n \"ItemId\": 84374,\r\n \"ItemName\": \"Devious Robe of the Harbingers\",\r\n \"Dkp\": 150,\r\n \"Notes\": \"\"\r\n },\r\n {\r\n \"CharacterId\": 84,\r\n \"CharacterName\": \"Ehff\",\r\n \"GameItemId\": 86132,\r\n \"ItemId\": 86132,\r\n \"ItemName\": \"Ductile Ornate Spaulders\",\r\n \"Dkp\": 134,\r\n \"Notes\": \"\"\r\n },\r\n {\r\n \"CharacterId\": 45,\r\n \"CharacterName\": \"Francey\",\r\n \"GameItemId\": 127573,\r\n \"ItemId\": 127573,\r\n \"ItemName\": \"War Forged Leather Shield\",\r\n \"Dkp\": 186,\r\n \"Notes\": \"\"\r\n },\r\n {\r\n \"CharacterId\": 14,\r\n \"CharacterName\": \"Heomap\",\r\n \"GameItemId\": 30459,\r\n \"ItemId\": 30459,\r\n \"ItemName\": \"Spell: Shroud of Death\",\r\n \"Dkp\": 145,\r\n \"Notes\": \"\"\r\n },\r\n {\r\n \"CharacterId\": 17,\r\n \"CharacterName\": \"Llamarider\",\r\n \"GameItemId\": 97182,\r\n \"ItemId\": 97182,\r\n \"ItemName\": \"Fine Giant Rat Pelt\",\r\n \"Dkp\": 156,\r\n \"Notes\": \"\"\r\n },\r\n {\r\n \"CharacterId\": 69,\r\n \"CharacterName\": \"Nokkard\",\r\n \"GameItemId\": 8052,\r\n \"ItemId\": 8052,\r\n \"ItemName\": \"Small Groove Nocks\",\r\n \"Dkp\": 148,\r\n \"Notes\": \"\"\r\n },\r\n {\r\n \"CharacterId\": 34,\r\n \"CharacterName\": \"Remmen\",\r\n \"GameItemId\": 43396,\r\n \"ItemId\": 43396,\r\n \"ItemName\": \"Faience Ring of Delusions\",\r\n \"Dkp\": 169,\r\n \"Notes\": \"\"\r\n },\r\n {\r\n \"CharacterId\": 20,\r\n \"CharacterName\": \"Satoshi\",\r\n \"GameItemId\": 97267,\r\n \"ItemId\": 97267,\r\n \"ItemName\": \"Crescent Perch\",\r\n \"Dkp\": 148,\r\n \"Notes\": \"\"\r\n },\r\n {\r\n \"CharacterId\": 35,\r\n \"CharacterName\": \"Sclif\",\r\n \"GameItemId\": 161443,\r\n \"ItemId\": 161443,\r\n \"ItemName\": \"Duende Plate Chest Ornament\",\r\n \"Dkp\": 197,\r\n \"Notes\": \"\"\r\n },\r\n {\r\n \"CharacterId\": 39,\r\n \"CharacterName\": \"Smexy\",\r\n \"GameItemId\": 48493,\r\n \"ItemId\": 48493,\r\n \"ItemName\": \"Blessed Nimble Symbol of Compassion\",\r\n \"Dkp\": 156,\r\n \"Notes\": \"\"\r\n },\r\n {\r\n \"CharacterId\": 39,\r\n \"CharacterName\": \"Smexy\",\r\n \"GameItemId\": 28640,\r\n \"ItemId\": 28640,\r\n \"ItemName\": \"Mystical Essence of Smoke\",\r\n \"Dkp\": 187,\r\n \"Notes\": \"\"\r\n },\r\n {\r\n \"CharacterId\": 63,\r\n \"CharacterName\": \"Terrorem\",\r\n \"GameItemId\": 119806,\r\n \"ItemId\": 119806,\r\n \"ItemName\": \"Prize: Tahka's Horse Saddle\",\r\n \"Dkp\": 148,\r\n \"Notes\": \"\"\r\n }\r\n ],\r\n \"Ticks\": [\r\n {\r\n \"TickId\": 1,\r\n \"Value\": 14,\r\n \"Description\": \"Hour #1\",\r\n \"Characters\": [\r\n {\r\n \"Name\": \"Icegrill\",\r\n \"CharacterId\": 36\r\n },\r\n {\r\n \"Name\": \"Regarof\",\r\n \"CharacterId\": 44\r\n },\r\n {\r\n \"Name\": \"Druksy\",\r\n \"CharacterId\": 11\r\n },\r\n {\r\n \"Name\": \"Waffle\",\r\n \"CharacterId\": 64\r\n },\r\n {\r\n \"Name\": \"Slowirl\",\r\n \"CharacterId\": 6\r\n },\r\n {\r\n \"Name\": \"Francey\",\r\n \"CharacterId\": 45\r\n },\r\n {\r\n \"Name\": \"Bigcooms\",\r\n \"CharacterId\": 10\r\n },\r\n {\r\n \"Name\": \"Meko\",\r\n \"CharacterId\": 58\r\n },\r\n {\r\n \"Name\": \"Doomfist\",\r\n \"CharacterId\": 55\r\n },\r\n {\r\n \"Name\": \"Bhikkhu\",\r\n \"CharacterId\": 54\r\n },\r\n {\r\n \"Name\": \"Novakain\",\r\n \"CharacterId\": 31\r\n },\r\n {\r\n \"Name\": \"Bruen\",\r\n \"CharacterId\": 81\r\n },\r\n {\r\n \"Name\": \"Marcone\",\r\n \"CharacterId\": 23\r\n },\r\n {\r\n \"Name\": \"Talanna\",\r\n \"CharacterId\": 73\r\n },\r\n {\r\n \"Name\": \"Glowers\",\r\n \"CharacterId\": 71\r\n },\r\n {\r\n \"Name\": \"Judg\",\r\n \"CharacterId\": 24\r\n },\r\n {\r\n \"Name\": \"Achievements\",\r\n \"CharacterId\": 76\r\n },\r\n {\r\n \"Name\": \"Undraksus\",\r\n \"CharacterId\": 13\r\n },\r\n {\r\n \"Name\": \"Terrorem\",\r\n \"CharacterId\": 63\r\n },\r\n {\r\n \"Name\": \"Ehff\",\r\n \"CharacterId\": 84\r\n },\r\n {\r\n \"Name\": \"Rencor\",\r\n \"CharacterId\": 72\r\n },\r\n {\r\n \"Name\": \"Lanin\",\r\n \"CharacterId\": 46\r\n },\r\n {\r\n \"Name\": \"Remooc\",\r\n \"CharacterId\": 7\r\n },\r\n {\r\n \"Name\": \"Beguiles\",\r\n \"CharacterId\": 47\r\n },\r\n {\r\n \"Name\": \"Drama\",\r\n \"CharacterId\": 86\r\n },\r\n {\r\n \"Name\": \"Giles\",\r\n \"CharacterId\": 85\r\n },\r\n {\r\n \"Name\": \"Poei\",\r\n \"CharacterId\": 12\r\n },\r\n {\r\n \"Name\": \"Shytcoin\",\r\n \"CharacterId\": 37\r\n },\r\n {\r\n \"Name\": \"Pedantic\",\r\n \"CharacterId\": 8\r\n },\r\n {\r\n \"Name\": \"Heomap\",\r\n \"CharacterId\": 14\r\n },\r\n {\r\n \"Name\": \"Szandor\",\r\n \"CharacterId\": 87\r\n },\r\n {\r\n \"Name\": \"Zell\",\r\n \"CharacterId\": 38\r\n },\r\n {\r\n \"Name\": \"Simplicity\",\r\n \"CharacterId\": 70\r\n },\r\n {\r\n \"Name\": \"Leopard\",\r\n \"CharacterId\": 32\r\n },\r\n {\r\n \"Name\": \"Danae\",\r\n \"CharacterId\": 42\r\n },\r\n {\r\n \"Name\": \"Sampsonite\",\r\n \"CharacterId\": 3\r\n },\r\n {\r\n \"Name\": \"Cuddin\",\r\n \"CharacterId\": 41\r\n },\r\n {\r\n \"Name\": \"Froogle\",\r\n \"CharacterId\": 28\r\n },\r\n {\r\n \"Name\": \"Smexy\",\r\n \"CharacterId\": 39\r\n },\r\n {\r\n \"Name\": \"Cloudburst\",\r\n \"CharacterId\": 68\r\n },\r\n {\r\n \"Name\": \"Moncs\",\r\n \"CharacterId\": 1\r\n },\r\n {\r\n \"Name\": \"Suvus\",\r\n \"CharacterId\": 77\r\n },\r\n {\r\n \"Name\": \"Fuddwin\",\r\n \"CharacterId\": 43\r\n },\r\n {\r\n \"Name\": \"Remmen\",\r\n \"CharacterId\": 34\r\n },\r\n {\r\n \"Name\": \"Taliefer\",\r\n \"CharacterId\": 60\r\n },\r\n {\r\n \"Name\": \"Wildybus\",\r\n \"CharacterId\": 53\r\n },\r\n {\r\n \"Name\": \"Dima\",\r\n \"CharacterId\": 21\r\n },\r\n {\r\n \"Name\": \"Kelu\",\r\n \"CharacterId\": 78\r\n },\r\n {\r\n \"Name\": \"Tacara\",\r\n \"CharacterId\": 48\r\n },\r\n {\r\n \"Name\": \"Duprix\",\r\n \"CharacterId\": 2\r\n },\r\n {\r\n \"Name\": \"Drav\",\r\n \"CharacterId\": 83\r\n },\r\n {\r\n \"Name\": \"Baneftw\",\r\n \"CharacterId\": 80\r\n },\r\n {\r\n \"Name\": \"Sclif\",\r\n \"CharacterId\": 35\r\n },\r\n {\r\n \"Name\": \"Sirena\",\r\n \"CharacterId\": 26\r\n },\r\n {\r\n \"Name\": \"Llamarider\",\r\n \"CharacterId\": 17\r\n },\r\n {\r\n \"Name\": \"Undraxis\",\r\n \"CharacterId\": 16\r\n },\r\n {\r\n \"Name\": \"Soakerz\",\r\n \"CharacterId\": 22\r\n },\r\n {\r\n \"Name\": \"Takecare\",\r\n \"CharacterId\": 33\r\n },\r\n {\r\n \"Name\": \"Yace\",\r\n \"CharacterId\": 66\r\n },\r\n {\r\n \"Name\": \"Lorthor\",\r\n \"CharacterId\": 62\r\n },\r\n {\r\n \"Name\": \"Xaga\",\r\n \"CharacterId\": 65\r\n },\r\n {\r\n \"Name\": \"Magetastic\",\r\n \"CharacterId\": 50\r\n },\r\n {\r\n \"Name\": \"Kilgrave\",\r\n \"CharacterId\": 4\r\n },\r\n {\r\n \"Name\": \"Airez\",\r\n \"CharacterId\": 79\r\n },\r\n {\r\n \"Name\": \"Madmanlizard\",\r\n \"CharacterId\": 30\r\n },\r\n {\r\n \"Name\": \"Catashe\",\r\n \"CharacterId\": 29\r\n },\r\n {\r\n \"Name\": \"Seloin\",\r\n \"CharacterId\": 27\r\n },\r\n {\r\n \"Name\": \"Brand\",\r\n \"CharacterId\": 82\r\n },\r\n {\r\n \"Name\": \"Nagev\",\r\n \"CharacterId\": 5\r\n }\r\n ]\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{host}}/clients/{{client}}/raids/1","description":"This HTTP POST request is used to add a raid for a specific client. The request should be sent to https://{{host}}/clients/{{client}}/raids/1. The request body should be in raw format and include parameters such as ClientId, Id, Name, Timestamp, Attendance, Pool, Items, and Ticks. The response will have a status code of 200 and a content type of application/json. The response will include the same parameters as the request, with the addition of the Pool's Name, Description, and Id.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"d66acc1b-90db-4884-a9ff-258c46941b15","id":"d66acc1b-90db-4884-a9ff-258c46941b15","name":"OpenDKP","type":"collection"}},"urlObject":{"protocol":"https","path":["clients","{{client}}","raids","1"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"eb2f5f90-b235-42fa-a938-7e543932aabb"},{"name":"Delete Raid","id":"9ce71df1-ec5a-48f6-a715-c431b180689b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://{{host}}/clients/{{client}}/raids/1","description":"This endpoint sends an HTTP DELETE request to remove a specific raid for a client. The request should be made to https://{{host}}/clients/{{client}}/raids/1.
\nThe response to the last execution had a status code of 200 and a content type of application/json. The response body included a message and a status code.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"d66acc1b-90db-4884-a9ff-258c46941b15","id":"d66acc1b-90db-4884-a9ff-258c46941b15","name":"OpenDKP","type":"collection"}},"urlObject":{"protocol":"https","path":["clients","{{client}}","raids","1"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"9ce71df1-ec5a-48f6-a715-c431b180689b"},{"name":"Insert Item into Raid","id":"e3e1b29e-be8c-4114-8a6a-04993efc31fd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"CharacterId\": 1,\r\n \"Dkp\": 1,\r\n \"Notes\": \"New API\",\r\n \"ItemId\" : 1001\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{host}}/clients/{{client}}/raids/2/items","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"d66acc1b-90db-4884-a9ff-258c46941b15","id":"d66acc1b-90db-4884-a9ff-258c46941b15","name":"OpenDKP","type":"collection"}},"urlObject":{"protocol":"https","path":["clients","{{client}}","raids","2","items"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e3e1b29e-be8c-4114-8a6a-04993efc31fd"}],"id":"fca9a5ee-5f96-44c9-8789-90635105ce8e","_postman_id":"fca9a5ee-5f96-44c9-8789-90635105ce8e","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"d66acc1b-90db-4884-a9ff-258c46941b15","id":"d66acc1b-90db-4884-a9ff-258c46941b15","name":"OpenDKP","type":"collection"}}},{"name":"Requests","item":[{"name":"Get All Requests","id":"f2287abb-bf1d-4909-ab57-9aea8c9d175c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://{{host}}/clients/{{client}}/requests","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"d66acc1b-90db-4884-a9ff-258c46941b15","id":"d66acc1b-90db-4884-a9ff-258c46941b15","name":"OpenDKP","type":"collection"}},"urlObject":{"protocol":"https","path":["clients","{{client}}","requests"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f2287abb-bf1d-4909-ab57-9aea8c9d175c"},{"name":"Get Request By Id","id":"65fc7df6-9135-4136-9657-ad5b9c2d14e0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://{{host}}/clients/{{client}}/requests/88436","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"d66acc1b-90db-4884-a9ff-258c46941b15","id":"d66acc1b-90db-4884-a9ff-258c46941b15","name":"OpenDKP","type":"collection"}},"urlObject":{"protocol":"https","path":["clients","{{client}}","requests","88436"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"65fc7df6-9135-4136-9657-ad5b9c2d14e0"},{"name":"Submit Access Request","id":"6166d928-e8bb-45cf-a89a-783313758952","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"RequestDetails\": \"{username:\\\"TEST_USER\\\"}\",\r\n \"RequestType\": 4\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{host}}/clients/{{client}}/requests","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"d66acc1b-90db-4884-a9ff-258c46941b15","id":"d66acc1b-90db-4884-a9ff-258c46941b15","name":"OpenDKP","type":"collection"}},"urlObject":{"protocol":"https","path":["clients","{{client}}","requests"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6166d928-e8bb-45cf-a89a-783313758952"},{"name":"Update Request","id":"82e6b1f8-bbd0-4e94-9f22-5a83126ec953","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"ClientId\": \"8c4a72641730b\",\r\n \"Id\": 88615,\r\n \"Requestor\": \"TEST_USER\",\r\n \"RequestType\": 4,\r\n \"RequestStatus\": 1,\r\n \"RequestTimestamp\": \"2024-03-06T19:31:04\",\r\n \"RequestApprover\": \"NONE\",\r\n \"ReviewedTimestamp\": \"0001-01-01T00:00:00\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{host}}/clients/{{client}}/requests","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"d66acc1b-90db-4884-a9ff-258c46941b15","id":"d66acc1b-90db-4884-a9ff-258c46941b15","name":"OpenDKP","type":"collection"}},"urlObject":{"protocol":"https","path":["clients","{{client}}","requests"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"82e6b1f8-bbd0-4e94-9f22-5a83126ec953"},{"name":"Get All Requests for Account","id":"0c3d0263-6434-4d53-ad64-38e647eca8ca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://{{host}}/clients/{{client}}/accounts/Admin/requests","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"d66acc1b-90db-4884-a9ff-258c46941b15","id":"d66acc1b-90db-4884-a9ff-258c46941b15","name":"OpenDKP","type":"collection"}},"urlObject":{"protocol":"https","path":["clients","{{client}}","accounts","Admin","requests"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"0c3d0263-6434-4d53-ad64-38e647eca8ca"},{"name":"Create Request","id":"47747e7b-8130-433c-8a9c-ba20dbe7b233","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"RequestDetails\": \"{characterId:3}\",\r\n \"RequestType\": 1\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{host}}/clients/{{client}}/requests","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"d66acc1b-90db-4884-a9ff-258c46941b15","id":"d66acc1b-90db-4884-a9ff-258c46941b15","name":"OpenDKP","type":"collection"}},"urlObject":{"protocol":"https","path":["clients","{{client}}","requests"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"47747e7b-8130-433c-8a9c-ba20dbe7b233"}],"id":"ce5f82bf-1f77-40fe-824b-1072bbdd6882","_postman_id":"ce5f82bf-1f77-40fe-824b-1072bbdd6882","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"d66acc1b-90db-4884-a9ff-258c46941b15","id":"d66acc1b-90db-4884-a9ff-258c46941b15","name":"OpenDKP","type":"collection"}}},{"name":"Auctions","item":[{"name":"Get All Auctions","id":"44bf94a4-5a8f-466d-b338-0de32e7598a4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://{{host}}/clients/{{client}}/auctions?page=1","urlObject":{"protocol":"https","path":["clients","{{client}}","auctions"],"host":["{{host}}"],"query":[{"key":"page","value":"1"}],"variable":[]}},"response":[],"_postman_id":"44bf94a4-5a8f-466d-b338-0de32e7598a4"},{"name":"Get Active Auctions","id":"d7518c3d-8928-4a06-b3c8-4a7c40a24226","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://{{host}}/clients/{{client}}/auctions/active","urlObject":{"protocol":"https","path":["clients","{{client}}","auctions","active"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d7518c3d-8928-4a06-b3c8-4a7c40a24226"},{"name":"Restore Auction","id":"e87dba64-ffc0-4288-aa7d-4bee8dae1231","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"AuctionId\": 9\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{host}}/clients/{{client}}/auctions","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"d66acc1b-90db-4884-a9ff-258c46941b15","id":"d66acc1b-90db-4884-a9ff-258c46941b15","name":"OpenDKP","type":"collection"}},"urlObject":{"protocol":"https","path":["clients","{{client}}","auctions"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e87dba64-ffc0-4288-aa7d-4bee8dae1231"},{"name":"Get Auction By Id","id":"035875fa-d892-49d2-9762-2d71085918d6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://{{host}}/clients/{{client}}/auctions/1","urlObject":{"protocol":"https","path":["clients","{{client}}","auctions","1"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"035875fa-d892-49d2-9762-2d71085918d6"},{"name":"Delete Auction By Id","id":"565f0998-179c-4b76-9bb8-d0b859147bc8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://{{host}}/clients/{{client}}/auctions/7","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"d66acc1b-90db-4884-a9ff-258c46941b15","id":"d66acc1b-90db-4884-a9ff-258c46941b15","name":"OpenDKP","type":"collection"}},"urlObject":{"protocol":"https","path":["clients","{{client}}","auctions","7"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"565f0998-179c-4b76-9bb8-d0b859147bc8"},{"name":"Create Auction","id":"73ba7dc6-a8c4-4fbb-82d4-5723907fdef0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"[\r\n {\r\n \"AuctionId\": 435399,\r\n \"BidType\": \"Open\",\r\n \"MinimumBid\": 10,\r\n \"MaximumBid\": 100,\r\n \"Duration\": 10,\r\n \"ItemQuantity\": 1,\r\n \"ItemId\": 6639,\r\n \"CreatedTimestamp\": \"2024-04-03T20:36:43.2370098Z\",\r\n \"EndTimestamp\": \"2024-04-03T20:46:43.2368096Z\",\r\n \"UpdatedTimestamp\": \"2024-04-03T20:36:43.2370368Z\",\r\n \"AllowDeletes\": false,\r\n \"Auctioneer\": \"Moncs\",\r\n \"AutoAdjustBids\": 1,\r\n \"Item\": {\r\n \"ItemId\": 6639,\r\n \"Name\": \"Tranquil Staff\",\r\n \"GameItemId\": 6639,\r\n \"IdGame\": 0\r\n },\r\n \"RaidId\": 4\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":"https://{{host}}/clients/{{client}}/auctions","description":"Expected Body is an array of auctions. It's expected that if you must create multiple auctions, send them in a batch style rather than individually.
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"d66acc1b-90db-4884-a9ff-258c46941b15","id":"d66acc1b-90db-4884-a9ff-258c46941b15","name":"OpenDKP","type":"collection"}},"urlObject":{"protocol":"https","path":["clients","{{client}}","auctions"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"73ba7dc6-a8c4-4fbb-82d4-5723907fdef0"},{"name":"End Auctions","id":"9637541d-2245-489d-9916-8ba00db437ed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\r\n {\r\n \"AuctionId\": 435402\r\n },\r\n {\r\n \"AuctionId\": 435403\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":"https://{{host}}/clients/{{client}}/auctions/endauctions","description":"Note that End Auctions is completely different from Delete Auction. When an auction is Ended, it sends the Auction to Bid Results page and awards items to Raids.
\nYou can pass in a full Auction object but the only thing needed is the AuctionIds to end an auction.
\nAgain, you pass in an array of objects to handle batch scenarios, please do not end auctions 1 at a time consecutively
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"d66acc1b-90db-4884-a9ff-258c46941b15","id":"d66acc1b-90db-4884-a9ff-258c46941b15","name":"OpenDKP","type":"collection"}},"urlObject":{"protocol":"https","path":["clients","{{client}}","auctions","endauctions"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"9637541d-2245-489d-9916-8ba00db437ed"},{"name":"Extend Auctions","id":"e30ae54a-e48a-455d-9c7d-ecfdb5fdb783","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\r\n {\r\n \"AuctionId\": 435404, \r\n \"EndTimestamp\": \"2024-04-03T21:19:27.000Z\",\r\n \"Notes\": null,\r\n \"AutoAdjustBids\": true\r\n },\r\n {\r\n \"AuctionId\": 435405,\r\n \"EndTimestamp\": \"2024-04-03T21:19:27.000Z\",\r\n \"Notes\": null,\r\n \"AutoAdjustBids\": true\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":"https://{{host}}/clients/{{client}}/auctions/extendauctions","description":"Extend Auctions accepts an array of partial Auctions object. When you perform an ExtendAuctions you can also update the Notes, AutoAdjustBids properties.
\nEndTimestamp should be the UTC time to end the auction.
\nPlease note, Extend Auction can be used to also Reduce auction, just pass in the appropriate EndTimestamp
\n","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"d66acc1b-90db-4884-a9ff-258c46941b15","id":"d66acc1b-90db-4884-a9ff-258c46941b15","name":"OpenDKP","type":"collection"}},"urlObject":{"protocol":"https","path":["clients","{{client}}","auctions","extendauctions"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e30ae54a-e48a-455d-9c7d-ecfdb5fdb783"}],"id":"ad0fb69b-442c-45da-b632-187dcd7e008e","_postman_id":"ad0fb69b-442c-45da-b632-187dcd7e008e","description":"","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"d66acc1b-90db-4884-a9ff-258c46941b15","id":"d66acc1b-90db-4884-a9ff-258c46941b15","name":"OpenDKP","type":"collection"}}},{"name":"oAuth 2.0","item":[{"name":"Get Access Token","id":"76e43df3-cafd-4782-be47-b389be1cd74d","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept-encoding":true,"accept":true,"user-agent":true,"connection":true,"content-type":true}},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/x-amz-json-1.1","type":"text"},{"key":"X-Amz-Target","value":"AWSCognitoIdentityProviderService.InitiateAuth","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"AuthParameters\" : {\r\n \"USERNAME\" : \"Admin\",\r\n \"PASSWORD\" : \"Admin123!\"\r\n },\r\n \"AuthFlow\" : \"USER_PASSWORD_AUTH\",\r\n \"ClientId\" : \"2sq61k8dj39e309tnh5tm70dd4\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://cognito-idp.us-east-2.amazonaws.com/","urlObject":{"protocol":"https","path":[""],"host":["cognito-idp","us-east-2","amazonaws","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"76e43df3-cafd-4782-be47-b389be1cd74d"}],"id":"dbe44ceb-9b9a-4312-97a6-8da036b8032d","description":"If you need to access these APIs programmatically, you can use the following POST request as a way to generate an oAuth 2.0 response. Please use the Access Token from the response as your Authorization Header.
\n","_postman_id":"dbe44ceb-9b9a-4312-97a6-8da036b8032d","auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"d66acc1b-90db-4884-a9ff-258c46941b15","id":"d66acc1b-90db-4884-a9ff-258c46941b15","name":"OpenDKP","type":"collection"}}}],"auth":{"type":"oauth2","oauth2":{"basicConfig":[]}},"event":[{"listen":"prerequest","script":{"id":"5ef8cdd4-d958-4fc2-82c1-90b81e524097","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"1a406f97-18a6-49e1-a57b-6af9e7d346df","type":"text/javascript","exec":[""]}}]}